GrandOrgue code and IDEs #771
Replies: 10 comments 19 replies
-
|
Because creating a project for IDE is not quite simple and may cause errors I prefer to include projects for different IDEs to the source tree. Personally I work with GO on different computers and keeping netbeans project in the repo solves the problem of synchronisation. |
Beta Was this translation helpful? Give feedback.
-
|
But not in separate folders in the root directory I hope. At least we should have a structure like /ide/netbeans, /ide/eclipse etc. You won't like it as much when I or someone else edit the files to suite our setup... We need to find a better way! In my opinion, only IDE project files that can be imported and used by anyone without user specific data should reside in the GO source tree. |
Beta Was this translation helpful? Give feedback.
-
|
The netbeans project files are rellocatable: the project may be cloned to any directory. |
Beta Was this translation helpful? Give feedback.
-
|
Good. Still, your personal files should be in your fork and not in the official repository. |
Beta Was this translation helpful? Give feedback.
-
|
Can you make an export of the netbeans project that others can actually import? That might have a place in the official repository. |
Beta Was this translation helpful? Give feedback.
-
|
Personal files are in the netbeans/private subdirectory and they are ignored by git. Everyone can open the progect in his own environment without any problems. Netbeans does not have any special 'export' feature because the same project can be opened by other people in every personal environment. |
Beta Was this translation helpful? Give feedback.
-
|
Have you looked into the project.xml and configurations.xml files of /nbproject? They both have:
and the likes of paths in them. Hardly useful for anyone else, right? I even tested opening them in netbeans and there's no useful way I can see to import or open the project from that folder or the content in it. So, I don't mind having some "ide_projects" folder in the source tree that's completely ignored in the official .gitignore and each developer can put whatever suits them there. But those files should not make their way into the official repository! And yes, it seems that it's possible to export a project as a .zip from netbeans, but as the project folder is now it's useless as far as I can see. |
Beta Was this translation helpful? Give feedback.
-
It does not prevent using this project files by anyone in any other directory path.
Netbeans calculates relative pathes from absolute paths of the files and the project root folder. Futher it uses only the relative paths and ignores the absolute paths at all. I agree that does not look very nice, but it is still working. I've made a context replacement of
Unfortunally most of IDEs require the predefined directory structure beyong the root project directory and will not work from
|
Beta Was this translation helpful? Give feedback.
-
If you use eclipse, yor are welcome to put the eclipse project to the repository.
My approach is to include projects for various IDEs in the source tree. It will make involving new people quite easier. |
Beta Was this translation helpful? Give feedback.
-
I use Netbeans 12.3 and 12.4 on different computers. I'm not sure that the project saved with netbeans 12.x can be easy opened with 10x. But maybe it works. |
Beta Was this translation helpful? Give feedback.
-
It is not a very good using the IDE because our build scripts can build GO from scratch and do not support incremental compilation. But incremental build save much time when you modify and debug only a few source files. So the better approach is to integrate cmake and make to the IDE.
If you do not like IDEs at all, you may not use them and may ignore existence of the IDE files in the source tree. But please do not make the life of the developers that use IDEs harder. Of cause, the IDE files should be workable with any people on every environment. |
Beta Was this translation helpful? Give feedback.
-
I don't want to enforce all developers to use only netbeans. Selecting a certain IDE is a thing of a flavor. But if we are talking about recruiting of new developers that it is malprobably that they are also old-school. Almost all young people prefer using IDEs. My approach is to allow them to put basic settings of their favorite IDEs to the repository. |
Beta Was this translation helpful? Give feedback.
-
Yes, that should be relatively easy since it's already working as it should. I'll test it later with eclipse. At least with netbeans 10.0 I couldn't get your instructions to work, I've also tested with 12.5 that's also available for Ubuntu 20.04 but it just complains about unrecognized project missing plugin? And I have c/c++ active. Some other? |
Beta Was this translation helpful? Give feedback.
-
|
Personally, I'd prefer to not include specific development environment stuffs in project. As some maybe want to have their specific configuration. In all the projects I've involved in, it's more common to have entries in .gitignore like : .vscode/ Constraining external tools in the project is generally a bad idea. |
Beta Was this translation helpful? Give feedback.
-
It makes setting up IDEs very hard. |
Beta Was this translation helpful? Give feedback.
-
|
But it's up to developer flavor. We cannot embed here every IDE's configuration as there are so much |
Beta Was this translation helpful? Give feedback.
-
|
But what we can do is to do something in wiki or ... |
Beta Was this translation helpful? Give feedback.
-
We shouldn't embed every existing IDEs, but only ones that are used by GrandOrgue developers. The number of developers is not very high; the number of used IDEs is less. |
Beta Was this translation helpful? Give feedback.
-
|
@larspalo I've just tested using my netbeans project in a fresh Ubuntu 18.04 by I wasn't able to do it with netbeans 10, but I was able to do it with netbeans 12.5. Steps to reproduce:
|
Beta Was this translation helpful? Give feedback.
-
|
@oleg68 Well, I could get it to "kind of" work with the instructions above. I could get netbeans to open the project but it reports warnings and errors - likely due to the absolute paths. So I get warnings for the folders like: This could likely be fixed by your change in making the paths relative instead.
However, it seems like you have ides/NetBeans12/nbproject/ for the files (three directories down) - why not directly in the ides/NetBeans12 folder (two directories down like above, or did I miss something? |
Beta Was this translation helpful? Give feedback.
-
If you have installed C/C++ plugin in nb 10, it does not work in nb 12. You should to uninstall this plugin with nb 10, then run nb 12.5 and install it again. It's better to clear ~/.netbeans directory before start using nb12 otherwise some artifacts from 10 may prevent C/C++ to work with 12.5 |
Beta Was this translation helpful? Give feedback.
-
I managed to move the netbeans project files from the root directory to the Please take a look at https://github.com/oleg68/GrandOrgue-oficial/tree/feature/move-netbeans . If it is OK, I will create a PR. Maybe eclipse also allows to do such trick? |
Beta Was this translation helpful? Give feedback.
-
|
@oleg68 This sounds reasonable. If the project files actually can be used by any developer and we have a working documentation of it - then ok, they can indeed have a place, I think. If eclipse also can do such things I cannot tell yet. If it doesn't work in the sub-directory but we still can create a usable project setup, I don't think it's a problem adding it to ides/eclipse together with a readme file (or other documentation) that explain how to move the .project file to root directory and make an entry in the .git/info/exclude file to still be able to use it. I can't say for sure about that yet. I'll test your instructions above first and see if I can get netbeans to work. |
Beta Was this translation helpful? Give feedback.
-
We are already doing this, arent't we?
Because netbeans requires the subdirectory named We could create a single project directory for all IDEs But disadvantages:
I thought that the directory name
I prefer to have ready-to use solutions than templates requiring manual steps before using them. You can just open the project
Yes, exactly. |
Beta Was this translation helpful? Give feedback.
-
Yes! That's the very point of this discussion.
Indeed, that would be a goal that makes the inclusion of project files in the repository justified as it can perhaps help beginning/new developers on the way. Still there's no replacement for the practical programming experience (coming from doing), but maybe we can make things a little smoother for others to begin the journey. As for the directory name I don't have any strong feelings really, |
Beta Was this translation helpful? Give feedback.
-
|
@larspalo So
Where might we put the howto-guides for using certain ides (like I posted above about netbeans)? To IDEs.md in the root directory? Or to
If we do not use it, it is difficult to make a well working project config. So l suggest to let to a new developer that is using codeblocks to do it. |
Beta Was this translation helpful? Give feedback.
-
|
I added #773 |
Beta Was this translation helpful? Give feedback.
-
|
Great! In a specialized directory is a good idea. |
Beta Was this translation helpful? Give feedback.
-
Currently the GO source code contain a /nbproject folder that's not essential to the GO source. In the .gitignore file only /nbproject/private is listed thus making any changes done in the /nbproject under version control. This is highly undesirable, I think. Personally I mostly use a simple text editor for coding, but perhaps we need to adopt a strategy that's suitable to different developers taste in IDEs and their different project files.
I suggest we remove the /nbproject folder and it's content from GrandOrgue source code. Next we agree upon a way in which developers should have their project files separate from the source code, and possibly add some entries to .gitignore that will cover all needed cases.
Beta Was this translation helpful? Give feedback.
All reactions