cmake: Recommend native CMake commands in README #1483

pull real-or-random wants to merge 1 commits into bitcoin-core:master from real-or-random:202401-cmake-native-readme changing 1 files +3 −3

real-or-random commented at 2:25 PM on January 17, 2024: contributor

Resolves one item in #1235. Closes #1294.

cc @hebasto
cmake: Recommend native CMake commands in README
Resolves one item in #1235. Closes #1294.
3777e3f36a
real-or-random added the label user-documentation on Jan 17, 2024
real-or-random added the label build on Jan 17, 2024
real-or-random cross-referenced this on Jan 17, 2024 from issue build: Meta-issue for follow-ups to initial CMake merge (#1113) by hebasto
in README.md:81 in 3777e3f36a
```
  78 | @@ -79,9 +79,9 @@ To maintain a pristine source tree, CMake encourages to perform an out-of-source
  79 |  
  80 |      $ mkdir build && cd build
  81 |      $ cmake ..
```
hebasto commented at 11:08 AM on January 18, 2024:

nit: Might be explicit:

$ cmake -S ..

?
real-or-random commented at 2:17 PM on January 18, 2024:

Hm, yeah, I think shorter is better, and omitting the -S is also more common. (See the official tutorial https://cmake.org/cmake/help/latest/guide/tutorial/A%20Basic%20Starting%20Point.html for example.)

hebasto commented at 3:32 PM on January 18, 2024:

OK, nm.
in README.md:84 in 3777e3f36a
```
  78 | @@ -79,9 +79,9 @@ To maintain a pristine source tree, CMake encourages to perform an out-of-source
  79 |  
  80 |      $ mkdir build && cd build
  81 |      $ cmake ..
  82 | -    $ make
  83 | -    $ make check  # run the test suite
  84 | -    $ sudo make install  # optional
  85 | +    $ cmake --build .
  86 | +    $ ctest  # run the test suite
  87 | +    $ sudo cmake --build . --target install  # optional
```
hebasto commented at 11:10 AM on January 18, 2024:

Is it worth mentioning a modern and more effective alternative, which is available for CMake >= 3.15:

$ sudo cmake --install . # optional

?
real-or-random commented at 2:19 PM on January 18, 2024:

Thanks for the suggestion. In fact, I had this first, but I changed to the current form because we still support CMake 3.13.

hebasto commented at 3:33 PM on January 18, 2024:

I mean, mention it additionally, not instead of the current line.

hebasto commented at 3:34 PM on January 18, 2024:

However, it's OK in its current view.
hebasto approved
hebasto commented at 11:11 AM on January 18, 2024: member

ACK 3777e3f36a61a05da19d5c6575fdd59288848948
jonasnick approved
jonasnick commented at 7:34 PM on January 23, 2024: contributor

ACK 3777e3f36a61a05da19d5c6575fdd59288848948
jonasnick merged this on Jan 23, 2024
jonasnick closed this on Jan 23, 2024

Contributors

real-or-random

hebasto

jonasnick

Labels

user-documentation build

Linked (view graph)

#1235 build: Meta-issue for follow-ups to initial CMake merge (#1113)#1294 cmake: Emulate GNU Autotools 'make check -jN'