Commit Graph

23 Commits

Author SHA1 Message Date
Brad King
e05b200be2 Help/dev: Update CMake Review Process document to suggest 'git describe'
Using `git describe --contains` is the preferred way to reference a
commit relative to a tag.
2020-08-20 07:29:06 -04:00
Jean-Christophe Fillion-Robin
207373802e Fix typos identified using codespell
See https://github.com/codespell-project/codespell#readme

The following command was used:

```
codespell -q6 --skip="\
.git,\
*.json,\
./Copyright.txt,\
./Help/command/foreach.rst,\
./Help/prop_test/REQUIRED_FILES.rst,\
./Help/variable/CTEST_COVERAGE_COMMAND.rst,\
./Modules/CMakeCheckCompilerFlagCommonPatterns.cmake,\
./Modules/CMakeRCInformation.cmake,\
./Modules/Internal/CPack/NSIS.template.in,\
./Modules/FindMatlab.cmake,\
./Modules/MatlabTestsRedirect.cmake,\
./Modules/Platform/Windows-Clang.cmake,\
./Modules/Platform/Windows-Intel-Fortran.cmake,\
./Modules/Platform/Windows-MSVC.cmake,\
./Source/CMakeVersion.cmake,\
./Source/cmConvertMSBuildXMLToJSON.py,\
./Source/cmCreateTestSourceList.cxx,\
./Source/cmGlobalVisualStudio10Generator.cxx,\
./Source/cmExportBuildFileGenerator.cxx,\
./Source/cmExportInstallAndroidMKGenerator.cxx,\
./Source/cmExportInstallFileGenerator.cxx,\
./Source/cmExportSet.cxx,\
./Source/cmExportTryCompileFileGenerator.cxx,\
./Source/cmFindPackageCommand.cxx,\
./Source/cmInstallCommand.cxx,\
./Source/cmGeneratorExpressionLexer.cxx,\
./Source/cmLocalVisualStudio7Generator.cxx,\
./Source/cmOrderDirectories.cxx,\
./Source/cmTarget.cxx,\
./Source/kwsys/*,\
./Source/QtDialog/CMakeSetupDialog.ui,\
./Source/CPack/WiX/cmWIXRichTextFormatWriter.cxx,\
./Source/CTest/cmParseCoberturaCoverage.h,\
./Tests/CMakeTests/ImplicitLinkInfoTest.cmake.in,\
./Tests/RunCMake/CPack/tests/DMG_SLA/English.license.rtf,\
./Tests/RunCMake/CPack/tests/DMG_SLA/German.license.txt,\
./Tests/RunCMake/CPack/tests/DMG_SLA/German.menu.txt,\
./Tests/RunCMake/GoogleTest/xml_output.cpp,\
./Tests/RunCMake/Make/TargetMessages*,\
./Utilities/*,\
" \
-L "\
dependees,\
endwhile,\
fo,\
filetest,\
helpfull,\
nd,\
objext,\
stoll,\
supercedes,\
superceded,\
vas,\
varn,\
"
```
2020-07-22 12:44:47 -04:00
Ben Boeckel
131b8cc8ae Help/dev: document other arguments to Do: test 2020-06-09 11:12:05 -04:00
Brad King
855ed80111 Help/dev: Update CMake Review Process document for GitLab CI
We have replaced use of `buildbot` with GitLab CI.  Update the
relevant section of our review process documentation.
2020-06-09 07:54:22 -04:00
Brad King
eb705b9531 Update links to gitlab.kitware.com repos to add -/
GitLab now uses a `/-/` component between the `group/project` part of
the URL and the `{issues,merge_requests,tree}` part so that it can
support `group/subgroup/project` with arbitrary depth.
2020-05-26 11:38:01 -04:00
Brad King
75a5d1d4b1 Help/dev: Document "Backport:" footer for MR descriptions 2019-11-11 23:24:29 +11:00
Brad King
12fd957ce3 Help/dev: Add 'external-discussion' to the main workflow status list
This was accidentally left out of commit 49f5b6f7bf (Help: Document the
expire and external discussion resolve states, 2019-05-26,
v3.15.0-rc1~35^2).
2019-11-06 12:02:23 -05:00
Craig Scott
49f5b6f7bf Help: Document the expire and external discussion resolve states
Our practice of closing MRs temporarily while discussion
takes place in a separate issue isn't always well understood
by MR authors. Expiring a MR seems to be better understood,
but making it clear that it is also a temporary state is helpful.
2019-05-30 19:45:54 +10:00
Ben Boeckel
939dc9a58c Help: prefer commit hashes in commit references
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.
2019-01-25 12:10:10 -05:00
Brad King
b99448e016 Help/dev: Document where topic stage branch is held 2018-12-19 11:53:14 -05:00
Craig Scott
82e01cbfc5 Help: Clarify usage of Topic-rename 2018-05-30 06:56:11 +10:00
Brad King
ee51f3746a Help/dev: Add commit reference format to review process guide 2017-08-29 13:01:47 -04:00
Brad King
c928439c23 Help/dev: Organize commit message instructions into subsections 2017-08-24 09:52:59 -04:00
Craig Scott
11d00a17aa Help/dev: Add commit message guidelines 2017-08-08 21:17:32 +10:00
Brad King
9685d0773c 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
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
9360e6c6a0 Help/dev: Document the CMake Review Process 2017-03-03 11:47:36 -05:00