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

cmake: Update documenation #65

Merged
merged 2 commits into from
Dec 27, 2024
Merged

cmake: Update documenation #65

merged 2 commits into from
Dec 27, 2024

Conversation

xkaraman
Copy link
Contributor

@xkaraman xkaraman commented Dec 16, 2024

I have split the docs into separate steps for configuration and building and change the table structure to have the comparison between Makefiles and CMakeFiles side by side.

What are your thoughts about this documentation update?

@henningw
Copy link
Contributor

Thank you. I would not add the jinja option to the comparison table, it might be confusing for new users. Maybe better creating a new page for usage with ninja build system.

@miconda
Copy link
Member

miconda commented Dec 16, 2024

Initial version of the file was with a table having side-by-side commands (https://github.com/kamailio/kamailio-wiki/blob/db4faaab7c9564880d32f0ff5eab659f1c90cc5b/docs/tutorials/cmake/commands.md), but I changed to one-after-the-other because for long description and long commands, the readability was not that good. Also copy&paste was not easy to do, lines being wrapped.

I am fine to split between config commands and build commands, but I would prefer the existing format rather than one row side-by-side.

@miconda
Copy link
Member

miconda commented Dec 16, 2024

And I also think that commands for ninja should be a separate page dedicated to it.

- Split between configuration and building

- Add various targets docs
@xkaraman xkaraman merged commit e83de3f into kamailio:main Dec 27, 2024
1 check passed
@xkaraman
Copy link
Contributor Author

This PR was merged by mistake while pushing another commit.
362b17f was reverted at 8773175

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

Successfully merging this pull request may close these issues.

3 participants