summaryrefslogtreecommitdiffstats
path: root/Help/dev
Commit message (Collapse)AuthorAgeFilesLines
* clang-tidy: Use `= delete`Regina Pfeifer2019-01-291-10/+0
|
* Help: prefer commit hashes in commit referencesBen Boeckel2019-01-251-5/+14
| | | | | | | | | | | The logic is that the describe output is readily available using `git tag --contains` locally. In addition, for a hypothetical commit which landed in both v3.9.4 and v3.10.1, there is no "better" tag to refer to. since v3.10.0's relation to such a commit is unclear either way. Also mention that a `Fixes` trailer is preferred if the mention is just to indicate a commit which introduced an error rather than writing a complete sentence about it.
* Help/dev: Document where topic stage branch is heldBrad King2018-12-191-0/+8
|
* Help/dev: Modernize module example in the CMake Documentation GuideBrad King2018-11-201-46/+38
|
* Help/dev: Factor out a CMake Documentation Guide for developing the docsBrad King2018-11-143-1/+542
| | | | | | 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.
* Help/dev: Drop 'size_t' preference from source code guideBrad King2018-11-141-7/+0
| | | | | 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`.
* Help: Add link to cmake_common.cmake in test process docsJean-Christophe Fillion-Robin2018-08-051-1/+2
|
* maint: Add further details about merging topics to release branchCraig Scott2018-07-251-3/+6
| | | | | | | | | | | 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.
* clang-format.bash: update to clang-format-6.0Brad King2018-06-011-1/+1
| | | | | | | | | | | | 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.
* Help: Clarify usage of Topic-renameCraig Scott2018-05-291-2/+5
|
* Help/dev: Add log step to 'release' branch instructionsBrad King2018-01-251-0/+7
| | | | | | 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.
* Fix trivial typos in textluzpaz2017-11-031-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* Use C++11 '= delete' instead of CM_EQ_DELETEBrad King2017-09-281-8/+0
| | | | | We now require C++11 support including `= delete`. Drop use of the old compatibility macro.
* Retire std::auto_ptr and its macro CM_AUTO_PTRMatthias Maennich2017-09-251-4/+2
| | | | Signed-off-by: Matthias Maennich <matthias@maennich.net>
* Help/dev: Add commit reference format to review process guideBrad King2017-08-291-0/+20
|
* Help/dev: Organize commit message instructions into subsectionsBrad King2017-08-241-0/+9
|
* Require C++11 to build CMake itselfBrad King2017-08-161-9/+7
| | | | | | | | | 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>
* Help/dev: Add commit message guidelinesCraig Scott2017-08-081-0/+48
|
* Help/dev: Add 'release' branch instructions to maintainer guideBrad King2017-07-211-0/+42
|
* Help/dev: Update maintainer guide with note about docs and testsBrad King2017-06-221-0/+2
|
* Help/dev: Add review instructions to maintainer guideBrad King2017-06-151-0/+30
|
* Tests: Document test directory layout in a README.rstBrad King2017-06-141-1/+3
| | | | | Cross-reference the CMake Source Code Guide document. Also drop the outdated `Tests/README` file.
* Help/dev: Update source code guide to cover source tree layoutBrad King2017-06-141-0/+45
|
* Help/dev: Add release branch creation to maintainer guideBrad King2017-06-021-0/+162
|
* Help/dev: Add a CMake Maintainer Guide documentBrad King2017-06-022-0/+18
| | | | | Initialize it with placeholder content. This document will serve to contain instructions for CMake maintenance processes.
* Help/dev: Document buildbot lint-iwyu-tidy builderBrad King2017-05-301-1/+6
| | | | | 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`.
* Help/dev: note that unstaging before an update is unnecessaryBen Boeckel2017-05-171-0/+4
|
* Help/dev: Document CM_EQ_DELETE and CM_DISABLE_COPYDaniel Pfeifer2017-04-251-0/+18
|
* Help/dev: Adopt C++ subset rules in coding guideBrad King2017-04-191-0/+21
| | | | | | 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.
* Help/dev: Adopt clang-format instructions in coding guideBrad King2017-04-191-0/+14
| | | | | Simplify the `CONTRIBUTING.rst` document by moving the code style section over to our dedicated coding guide and linking to it instead.
* Help/dev: Add a CMake Source Code Guide placeholderBrad King2017-04-192-0/+16
| | | | | Create a dedicated document to cover the CMake source code for developers.
* Help/dev: Document preferred page for MR commentsBrad King2017-04-061-0/+4
|
* Help/dev: Document `Do: reformat` actionBrad King2017-03-221-0/+16
|
* Help/dev: Make `Do: check` cross-reference more specificBrad King2017-03-221-1/+4
| | | | Add a dedicated subsection header for its documentation.
* Help/dev: Document `Topic-rename:` description trailerBrad King2017-03-211-0/+7
|
* Help/dev: mention how the robot performs its checksBen Boeckel2017-03-211-3/+8
| | | | Fixes: #16264.
* Help/dev: Document the CMake Testing ProcessBrad King2017-03-073-8/+54
|
* Help/dev: Revise README to have a bullet list of available documentsBrad King2017-03-071-2/+4
|
* Help/dev: Document the CMake Review ProcessBrad King2017-03-032-0/+316
|
* Help/dev: Exclude this directory from user-facing documentationBrad King2017-03-011-0/+15
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.