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

Restructure cmake_options.rst #2230

Merged
merged 22 commits into from
Jan 16, 2022
Merged

Conversation

stinebuu
Copy link
Contributor

@stinebuu stinebuu commented Dec 7, 2021

This fixes #2067.

Convert to tables, and restructure ordering.

@stinebuu stinebuu added S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Dec 7, 2021
@stinebuu stinebuu added this to In progress in Documentation via automation Dec 7, 2021
@stinebuu stinebuu added this to the NEST 3.2 milestone Dec 7, 2021
Copy link
Contributor

@heplesser heplesser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, that will be much better. I added some suggestion for organizing items a bit differently to provide an even better overview to the user.

doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
Documentation automation moved this from In progress to Review Dec 15, 2021
@stinebuu
Copy link
Contributor Author

@heplesser I think I have addressed all your comments, could you have a second look?

Copy link
Contributor

@heplesser heplesser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stinebuu Thanks a lot! Going through once again I noticed a number of further details, see below. Two general points:

  • Should the entries in the left column all be typeset as code, e.g., -Dwith-python=[OFF|ON|...]?
  • I think it would look tidier to put the bracket with the default into the sentence, i.e., like "Build with MPI parallelization [default: OFF]."
  • I also think that the defaults are not all given in the same way, some with :, some with =, some with space.

doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
doc/userdoc/installation/cmake_options.rst Outdated Show resolved Hide resolved
@stinebuu
Copy link
Contributor Author

@heplesser Thanks for your comments! I have addressed them now, please have another look.

Do you want me to also update the cmake options in CMakeLists.txt to fit with the changes in this PR?

set( tics_per_ms "1000.0" CACHE STRING "Specify elementary unit of time. [default 1000.0]" )
set( tics_per_step "100" CACHE STRING "Specify resolution. [default 100]" )
# add user modules
set( external-modules OFF CACHE STRING "External NEST modules to be linked in, separated by ';'. [default=OFF]" )

The table widths are quite long now (at least for some of the tables), because I don't know how to cut the links over two lines (the SIONLIB link is the main problem). The width of the External libraries table is now 155 characters. For me this is okay, but I wanted to point it out just in case.

@heplesser
Copy link
Contributor

@stinebuu Yes, having the same information in the CMakeLists.txt would be good. Inconsistency is irritating for users. I think the wide lines should not be a problem, they will be rendered nicely by Sphinx, I believe. @jessica-mitchell, can you confirm this?

Copy link
Contributor

@jessica-mitchell jessica-mitchell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stinebuu looks good! The large tables render fine as well :)

@heplesser heplesser merged commit 28a2458 into nest:master Jan 16, 2022
Documentation automation moved this from Review to Done Jan 16, 2022
@stinebuu stinebuu deleted the git_cmake_options branch January 17, 2022 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Documentation
  
Done
Development

Successfully merging this pull request may close these issues.

Revise cmake_options.rst
3 participants