doc: fix some typos
PATCH 1/1 doc: fix some typos
From: Thomas Ackermann <[email protected]>
---
doc: fix some typos
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-831%2Ftacker66%2Ffix_some_typos-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-831/tacker66/fix_some_typos-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/831
Documentation/config/http.txt | 4 ++-- Documentation/config/trace2.txt | 2 +- Documentation/git-maintenance.txt | 2 +- Documentation/git-p4.txt | 2 +- Documentation/githooks.txt | 2 +- Documentation/technical/reftable.txt | 2 +- contrib/buildsystems/CMakeLists.txt | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-)
Documentation/config/http.txt +2 -2
@@ -42,12 +42,12 @@ http.proxySSLKey:: http.proxySSLCertPasswordProtected:: Enable Git's password prompt for the proxy SSL certificate. Otherwise OpenSSL will prompt the user, possibly many times, if the certificate or private key - is encrypted. Can be overriden by the `GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED` + is encrypted. Can be overridden by the `GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED` environment variable. http.proxySSLCAInfo:: Pathname to the file containing the certificate bundle that should be used to - verify the proxy with when using an HTTPS proxy. Can be overriden by the + verify the proxy with when using an HTTPS proxy. Can be overridden by the `GIT_PROXY_SSL_CAINFO` environment variable. http.emptyAuth::
Documentation/config/trace2.txt +1 -1
@@ -54,7 +54,7 @@ trace2.envVars:: `GIT_HTTP_USER_AGENT,GIT_CONFIG` would cause the trace2 output to contain events listing the overrides for HTTP user agent and the location of the Git configuration file (assuming any are set). May be - overriden by the `GIT_TRACE2_ENV_VARS` environment variable. Unset by + overridden by the `GIT_TRACE2_ENV_VARS` environment variable. Unset by default. trace2.destinationDebug::
Documentation/git-maintenance.txt +1 -1
@@ -38,7 +38,7 @@ register:: for running in the background without disrupting foreground processes. + -The `register` subcomand will also set the `maintenance.strategy` config +The `register` subcommand will also set the `maintenance.strategy` config value to `incremental`, if this value is not previously set. The `incremental` strategy uses the following schedule for each maintenance task:
Documentation/git-p4.txt +1 -1
@@ -397,7 +397,7 @@ changelist text. Exiting with a non-zero status from the script will abort the process. The purpose of the hook is to edit the message file in place, -and it is not supressed by the `--no-verify` option. This hook +and it is not suppressed by the `--no-verify` option. This hook is called even if `--prepare-p4-only` is set. p4-changelist
Documentation/githooks.txt +1 -1
@@ -644,7 +644,7 @@ changelist text. Exiting with a non-zero status from the script will abort the process. The purpose of the hook is to edit the message file in place, -and it is not supressed by the `--no-verify` option. This hook +and it is not suppressed by the `--no-verify` option. This hook is called even if `--prepare-p4-only` is set. Run `git-p4 submit --help` for details.
Documentation/technical/reftable.txt +1 -1
@@ -446,7 +446,7 @@ especially if readers will not use the object name to ref mapping. Object blocks use unique, abbreviated 2-32 object name keys, mapping to ref blocks containing references pointing to that object directly, or as the peeled value of an annotated tag. Like ref blocks, object blocks use -the file's standard block size. The abbrevation length is available in +the file's standard block size. The abbreviation length is available in the footer as `obj_id_len`. To save space in small files, object blocks may be omitted if the ref
contrib/buildsystems/CMakeLists.txt +1 -1
@@ -442,7 +442,7 @@ endif() check_c_source_compiles(" #include <regex.h> #ifndef REG_STARTEND -#error oops we dont have it +#error oops we don't have it #endif int main(void)
base-commit: 71ca53e8125e36efbda17293c50027d31681a41f
Signature · 1 line
gitgitgadget
On Sat, 2 Jan 2021 at 18:43, Thomas Ackermann via GitGitGadget <[email protected]> wrote:
[Snip several typo fixes in Documentation/, all of which I agree with.]
contrib/buildsystems/CMakeLists.txt
Quoted 4 lines
contrib/buildsystems/CMakeLists.txt +0
-0
Hmm... This does not match the "doc:" prefix of the patch.
contrib/buildsystems/CMakeLists.txt endif() · line 446
Quoted 7 lines
contrib/buildsystems/CMakeLists.txt +1
-1@@ -442,7 +442,7 @@ endif() check_c_source_compiles(" #include <regex.h> #ifndef REG_STARTEND -#error oops we dont have it +#error oops we don't have it #endif
I don't think this is correct. This omission of the single quote somehow looks like it's done on purpose. I don't build using this system, but I tried making some silly code like this in another file, which I actually do use:
#if 0
#error might or mightn't work
#endif
My compiler refused to compile: "error: missing terminating ' character [-Werror]". So I fear this change to CMakeLists.txt would make us needlessly fail to autodetect whatever it is we're looking for here.
If this change to CMakeLists.txt is dropped, this patch looks good to me.
Martin
Quoted 25 lines · Martin Ågren
On Sat, 2 Jan 2021 at 18:43, Thomas Ackermann via GitGitGadget <[email protected]> wrote:
[Snip several typo fixes in
Documentation/, all of which I agree with.]contrib/buildsystems/CMakeLists.txt
Quoted 4 lines
contrib/buildsystems/CMakeLists.txt +0
-0Hmm... This does not match the "doc:" prefix of the patch.
contrib/buildsystems/CMakeLists.txt endif() · line 446
Quoted 7 lines
contrib/buildsystems/CMakeLists.txt +1
-1@@ -442,7 +442,7 @@ endif() check_c_source_compiles(" #include <regex.h> #ifndef REG_STARTEND -#error oops we dont have it +#error oops we don't have it #endifI don't think this is correct. This omission of the single quote somehow looks like it's done on purpose. I don't build using this system, but I tried making some silly code like this in another file, which I actually do use:
Quoted 3 lines
#if 0
#error might or mightn't work
#endif
But this works:
#error "might or mightn't work"
Signature · 1 line
Felipe Contreras
Quoted 27 lines · Felipe Contreras
Quoted 25 lines · Martin Ågren
On Sat, 2 Jan 2021 at 18:43, Thomas Ackermann via GitGitGadget <[email protected]> wrote:
[Snip several typo fixes in
Documentation/, all of which I agree with.]contrib/buildsystems/CMakeLists.txt
Quoted 4 lines
contrib/buildsystems/CMakeLists.txt +0
-0Hmm... This does not match the "doc:" prefix of the patch.
contrib/buildsystems/CMakeLists.txt endif() · line 446
Quoted 7 lines
contrib/buildsystems/CMakeLists.txt +1
-1@@ -442,7 +442,7 @@ endif() check_c_source_compiles(" #include <regex.h> #ifndef REG_STARTEND -#error oops we dont have it +#error oops we don't have it #endifI don't think this is correct. This omission of the single quote somehow looks like it's done on purpose. I don't build using this system, but I tried making some silly code like this in another file, which I actually do use:
Quoted 7 lines
Quoted 3 lines
#if 0
#error might or mightn't work
#endifBut this works:
#error "might or mightn't work"
Yeah, I pondered writing something like that. But then I thought I would also need to write something about how, at the least, it should still be a separate patch, but also how even if it were a separate patch, I would probably sort it under code churn (IMVHO).
The error is not really intended for anyone's eyes, at least assuming my reading is correct. So I refrained from suggesting to Thomas that here's how you could go about making such a change.
And now I ended up laying out my thoughts anyway. :-) Of course, others may well disagree with me about this being code churn.
Martin
Quoted 11 lines · Martin Ågren
Quoted 9 lines · Felipe Contreras
Quoted 3 lines · Martin Ågren
#if 0
#error might or mightn't work
#endifBut this works:
#error "might or mightn't work"
[...]
Quoted 2 lines
And now I ended up laying out my thoughts anyway. :-) Of course, others may well disagree with me about this being code churn.
Either way it's not integral to the rest of the patch. The change can be dropped, or fixed properly. It probably doesn't matter much.
Signature · 1 line
Felipe Contreras
Quoted 3 lines · Felipe Contreras
But this works:
#error "might or mightn't work"
Right: the rule here is that the preprocessor, even inside "#if 0" sections, is working with "pp-token"s. Single quotes are still character constants and must be paired. Double quotes are still string constants (token-wise) and also must be paired like this, but now you can hide apostrophes.
Chris
PATCH v2 1/1 doc: fix some typos
In reply to Thomas Ackermann via GitGitGadgetFrom: Thomas Ackermann <[email protected]>
---
doc: fix some typos
Changed since v1:
* Removed changes in non-doc file contrib/buildsystems/CMakeLists.txt from the patch. Thanks to Martin and Felipe for pointing this out.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-831%2Ftacker66%2Ffix_some_typos-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-831/tacker66/fix_some_typos-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/831
Range-diff vs v1:
1: 7016f417044 ! 1: 67e26552cb6 doc: fix some typos
@@ Documentation/technical/reftable.txt: especially if readers will not use the obj
the footer as obj_id_len.
To save space in small files, object blocks may be omitted if the ref
-
- ## contrib/buildsystems/CMakeLists.txt ##
-@@ contrib/buildsystems/CMakeLists.txt: endif()
- check_c_source_compiles("
- #include <regex.h>
- #ifndef REG_STARTEND
--#error oops we dont have it
-+#error oops we don't have it
- #endif
-
- int main(void)
Documentation/config/http.txt | 4 ++-- Documentation/config/trace2.txt | 2 +- Documentation/git-maintenance.txt | 2 +- Documentation/git-p4.txt | 2 +- Documentation/githooks.txt | 2 +- Documentation/technical/reftable.txt | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-)
Documentation/config/http.txt +2 -2
@@ -42,12 +42,12 @@ http.proxySSLKey:: http.proxySSLCertPasswordProtected:: Enable Git's password prompt for the proxy SSL certificate. Otherwise OpenSSL will prompt the user, possibly many times, if the certificate or private key - is encrypted. Can be overriden by the `GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED` + is encrypted. Can be overridden by the `GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED` environment variable. http.proxySSLCAInfo:: Pathname to the file containing the certificate bundle that should be used to - verify the proxy with when using an HTTPS proxy. Can be overriden by the + verify the proxy with when using an HTTPS proxy. Can be overridden by the `GIT_PROXY_SSL_CAINFO` environment variable. http.emptyAuth::
Documentation/config/trace2.txt +1 -1
@@ -54,7 +54,7 @@ trace2.envVars:: `GIT_HTTP_USER_AGENT,GIT_CONFIG` would cause the trace2 output to contain events listing the overrides for HTTP user agent and the location of the Git configuration file (assuming any are set). May be - overriden by the `GIT_TRACE2_ENV_VARS` environment variable. Unset by + overridden by the `GIT_TRACE2_ENV_VARS` environment variable. Unset by default. trace2.destinationDebug::
Documentation/git-maintenance.txt +1 -1
@@ -38,7 +38,7 @@ register:: for running in the background without disrupting foreground processes. + -The `register` subcomand will also set the `maintenance.strategy` config +The `register` subcommand will also set the `maintenance.strategy` config value to `incremental`, if this value is not previously set. The `incremental` strategy uses the following schedule for each maintenance task:
Documentation/git-p4.txt +1 -1
@@ -397,7 +397,7 @@ changelist text. Exiting with a non-zero status from the script will abort the process. The purpose of the hook is to edit the message file in place, -and it is not supressed by the `--no-verify` option. This hook +and it is not suppressed by the `--no-verify` option. This hook is called even if `--prepare-p4-only` is set. p4-changelist
Documentation/githooks.txt +1 -1
@@ -644,7 +644,7 @@ changelist text. Exiting with a non-zero status from the script will abort the process. The purpose of the hook is to edit the message file in place, -and it is not supressed by the `--no-verify` option. This hook +and it is not suppressed by the `--no-verify` option. This hook is called even if `--prepare-p4-only` is set. Run `git-p4 submit --help` for details.
Documentation/technical/reftable.txt +1 -1
@@ -446,7 +446,7 @@ especially if readers will not use the object name to ref mapping. Object blocks use unique, abbreviated 2-32 object name keys, mapping to ref blocks containing references pointing to that object directly, or as the peeled value of an annotated tag. Like ref blocks, object blocks use -the file's standard block size. The abbrevation length is available in +the file's standard block size. The abbreviation length is available in the footer as `obj_id_len`. To save space in small files, object blocks may be omitted if the ref
base-commit: 71ca53e8125e36efbda17293c50027d31681a41f
Signature · 1 line
gitgitgadget
Hi Thomas,
Quoted 11 lines · Thomas Ackermann via GitGitGadget
From: Thomas Ackermann <[email protected]>
Signed-off-by Thomas Ackermann <[email protected]>---
doc: fix some typosChanged since v1:
* Removed changes in non-doc file
contrib/buildsystems/CMakeLists.txtfrom the patch. Thanks to Martin and Felipe for pointing this out.
This looks good to me.
Martin
Quoted 11 lines · Martin Ågren
Hi Thomas,
Quoted 7 lines · Thomas Ackermann via GitGitGadget
From: Thomas Ackermann <[email protected]>
Signed-off-by Thomas Ackermann <[email protected]>---
doc: fix some typos
Quoted 8 lines
Quoted 4 lines
Changed since v1:
* Removed changes in non-doc file
contrib/buildsystems/CMakeLists.txtfrom the patch. Thanks to Martin and Felipe for pointing this out.This looks good to me.
Martin
Thanks, all.