Commit Graph

36 Commits

Author SHA1 Message Date
Brad King a05a9fb2b8 Help/dev: Factor out a CMake Documentation Guide for developing the docs
Remove this content from the `cmake-developer(7)` manual because it
is relevant only to developers working on CMake itself.  Move it to
a guide in the developer documentation.
2018-11-14 14:38:13 -05:00
Brad King c6cd2c9256 Help/dev: Drop 'size_t' preference from source code guide
We now use `std::size_t` in several places and it is fully supported by
C++11 compilers.  Drop the recommendation to prefer plain `size_t`.
2018-11-14 14:28:57 -05:00
Jean-Christophe Fillion-Robin 8eb7f7f103 Help: Add link to cmake_common.cmake in test process docs 2018-08-05 19:33:28 +10:00
Craig Scott 681d14e017 maint: Add further details about merging topics to release branch
The Maintain Current Release instructions previously assumed that
the topic branch had been merged to master. Add text to make this
explicit in the instructions as an initial verification step.

The previous instructions also made no mention of the commit
message for the merge to the release branch. This needs to include
a footer that mentions the merge request number for tracking
purposes.
2018-07-26 07:41:19 +10:00
Brad King 24457cd523 clang-format.bash: update to clang-format-6.0
Update `.clang-format` with configuration to make the 6.0 format as
close as possible to what 3.8 produced before.  Then revise the style:

* Indent preprocessor directives (a feature new since 3.8)
* Add a newline and indentation before inheritance `:` and `,`

Rename the Git attribute identifying the format to include the
clang-format version number: `format.clang-format-6.0`.  This will aid
external infrastructure in knowing what version of the tool to run.
2018-06-01 09:52:02 -04:00
Craig Scott 5e41ff3fa9 Help: Clarify usage of Topic-rename 2018-05-30 06:56:11 +10:00
Brad King 1b8db14b70 Help/dev: Add log step to 'release' branch instructions
Extend the maintainer guide with a reminder to self-review the
new ancestry of the `release` and `master` branches to ensure
that nothing unexpected was merged.
2018-01-25 09:44:36 -05:00
luzpaz d74deb9cc0 Fix trivial typos in text
Some are user facing.

Found using

    codespell -q 3 --skip="./Utilities" -I .cmake-whitelist.txt`

whereby the whitelist contained:

    ans
    dum
    helpfull
    emmited
    emmitted
    buil
    iff
    isnt
    nto
    ot
    pathes
    substract
    te
    todays
    upto
    whitespaces
2017-11-03 10:25:05 -04:00
Brad King 4f5081e495 Use C++11 '= delete' instead of CM_EQ_DELETE
We now require C++11 support including `= delete`.  Drop use of
the old compatibility macro.
2017-09-28 09:50:18 -04:00
Matthias Maennich 345c7ccb4e Retire std::auto_ptr and its macro CM_AUTO_PTR
Signed-off-by: Matthias Maennich <matthias@maennich.net>
2017-09-26 00:07:19 +02:00
Brad King ba0540c5d9 Help/dev: Add commit reference format to review process guide 2017-08-29 13:01:47 -04:00
Brad King 0a791778c7 Help/dev: Organize commit message instructions into subsections 2017-08-24 09:52:59 -04:00
Brad King dd3a621858 Require C++11 to build CMake itself
CMake can now compile as C++11 on all supported platforms.  Check that
std::unique_ptr is available and fail early if missing.  This will allow
us to use C++11 more broadly in CMake's implementation (previously it
was restricted to the serve mode implementation).

Co-Author: Daniel Pfeifer <daniel@pfeifer-mail.de>
2017-08-16 10:13:38 -04:00
Craig Scott 89ea56d1ce Help/dev: Add commit message guidelines 2017-08-08 21:17:32 +10:00
Brad King 8ec4192a3e Help/dev: Add 'release' branch instructions to maintainer guide 2017-07-21 11:51:30 -04:00
Brad King 6a88e9853b Help/dev: Update maintainer guide with note about docs and tests 2017-06-22 11:02:05 -04:00
Brad King 0f3c860a7e Help/dev: Add review instructions to maintainer guide 2017-06-15 14:32:54 -04:00
Brad King 804e8c4293 Tests: Document test directory layout in a README.rst
Cross-reference the CMake Source Code Guide document.
Also drop the outdated `Tests/README` file.
2017-06-14 15:04:19 -04:00
Brad King 43e8311def Help/dev: Update source code guide to cover source tree layout 2017-06-14 15:03:50 -04:00
Brad King f942f2f5c0 Help/dev: Add release branch creation to maintainer guide 2017-06-02 14:36:52 -04:00
Brad King fe523717e3 Help/dev: Add a CMake Maintainer Guide document
Initialize it with placeholder content.  This document will serve to
contain instructions for CMake maintenance processes.
2017-06-02 14:24:47 -04:00
Brad King cf89ab37ef Help/dev: Document buildbot lint-iwyu-tidy builder
This builder builds CMake using lint tools but does not run the test
suite.  Document it for reviewers to request with `Do: test -i lint`.
2017-05-30 09:34:30 -04:00
Ben Boeckel 1c25adb210 Help/dev: note that unstaging before an update is unnecessary 2017-05-17 13:05:00 -04:00
Daniel Pfeifer d0b70e676e Help/dev: Document CM_EQ_DELETE and CM_DISABLE_COPY 2017-04-25 22:08:47 +02:00
Brad King caabb6e1f3 Help/dev: Adopt C++ subset rules in coding guide
Move the C++ subset rules from the `cmake-developer(7)` into our
dedicated coding guide since they do not need to be in user-facing
documentation.
2017-04-19 16:41:58 -04:00
Brad King 0fd255adf5 Help/dev: Adopt clang-format instructions in coding guide
Simplify the `CONTRIBUTING.rst` document by moving the code style
section over to our dedicated coding guide and linking to it instead.
2017-04-19 16:33:06 -04:00
Brad King 540b4cdc2b Help/dev: Add a CMake Source Code Guide placeholder
Create a dedicated document to cover the CMake source code for
developers.
2017-04-19 16:18:26 -04:00
Brad King 43381b4de7 Help/dev: Document preferred page for MR comments 2017-04-06 09:53:19 -04:00
Brad King 72f534ca15 Help/dev: Document Do: reformat action 2017-03-22 09:47:30 -04:00
Brad King 2192247e33 Help/dev: Make Do: check cross-reference more specific
Add a dedicated subsection header for its documentation.
2017-03-22 09:41:53 -04:00
Brad King 5fe3630677 Help/dev: Document Topic-rename: description trailer 2017-03-21 15:46:32 -04:00
Ben Boeckel 7d22203912 Help/dev: mention how the robot performs its checks
Fixes: #16264.
2017-03-21 14:53:31 -04:00
Brad King 2927e437e0 Help/dev: Document the CMake Testing Process 2017-03-07 11:05:57 -05:00
Brad King b55e19dd1f Help/dev: Revise README to have a bullet list of available documents 2017-03-07 10:40:56 -05:00
Brad King 9360e6c6a0 Help/dev: Document the CMake Review Process 2017-03-03 11:47:36 -05:00
Brad King d33de80c8a Help/dev: Exclude this directory from user-facing documentation
Teach Sphinx and our own install rules to skip a `Help/dev` directory.
This will give us a place to put developer-only documentation that
should not be included in the user-facing documentation.  Add a
placeholder README.
2017-03-01 16:05:55 -05:00