Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docs for CMake #11437

Open
HTRamsey opened this issue May 1, 2024 · 4 comments
Open

Update Docs for CMake #11437

HTRamsey opened this issue May 1, 2024 · 4 comments
Assignees
Labels

Comments

@HTRamsey
Copy link
Collaborator

HTRamsey commented May 1, 2024

  • I would remove the centos 7 page. There is nothing particularly unique about the centos process, also centos 7 is EOL.
  • I think the command options need to be updated
  • Custom Builds will need to be updated when they are complete
  • I dont think there are dev calls so maybe remove that?
  • The warning on the Licensing page is incorrect
@DonLakeFlyer
Copy link
Contributor

  • The warning on the Licensing page is incorrect

What part? It just seems to be a repeat of what is said above it: "QGroundControl (QGC) is dual-licensed as Apache 2.0 and GPLv3. All contributions have to be made under both licenses. Users of the codebase are free to use it under either license."

I don't think it's really needed, but not sure what part you think is wrong?

@HTRamsey
Copy link
Collaborator Author

HTRamsey commented May 5, 2024

The part where it says "QGroundControl licensing rules out the re-use of any copyleft (e.g. GPL) licensed code. All contributions must be original or from a compatible license (BSD 2/3 clause, MIT, Apache 2.0).".
It doesn't make sense to 'rule out' using GPL when it is GPL licensed itself.

@smadi0x86
Copy link

I would like to also note that the command in the QGroundControl documentation for building the project with CMake cli has a missing flag:

This command should include the -D flag:

cmake -B build -G Ninja -DCMAKE_BUILD_TYPE=Debug

Proposed Solution:

Update the documentation to use the correct CMake command with the -D flag.

Without the -D flag, CMake does not interpret CMAKE_BUILD_TYPE=Debug as a variable definition. Instead, it treats it as an additional path or parameter, leading to this error:

CMake Error: The source directory "~/dev/Personal/qgroundcontrol/CMAKE_BUILD_TYPE=Debug" does not exist.
Specify --help for usage, or press the help button on the CMake GUI.

Additional Information:

This worked for me to build using cmake cli, however, I might be doing something wrong, so please let me know if there are any additional steps or corrections needed.

@DonLakeFlyer
Copy link
Contributor

  • I would remove the centos 7 page. There is nothing particularly unique about the centos process, also centos 7 is EOL.

Done

  • I dont think there are dev calls so maybe remove that?

Done

This command should include the -D flag:

Done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants