From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jeff King Subject: [PATCH 6/8] doc: convert \--option to --option Date: Wed, 13 May 2015 01:01:38 -0400 Message-ID: <20150513050137.GF6821@peff.net> References: <20150513045650.GA6070@peff.net> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Cc: Jean-Noel Avila , git@vger.kernel.org To: Junio C Hamano X-From: git-owner@vger.kernel.org Wed May 13 07:01:47 2015 Return-path: Envelope-to: gcvg-git-2@plane.gmane.org Received: from vger.kernel.org ([209.132.180.67]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1YsOni-0008Ur-BD for gcvg-git-2@plane.gmane.org; Wed, 13 May 2015 07:01:47 +0200 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751065AbbEMFBm (ORCPT ); Wed, 13 May 2015 01:01:42 -0400 Received: from cloud.peff.net ([50.56.180.127]:57618 "HELO cloud.peff.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with SMTP id S1751005AbbEMFBk (ORCPT ); Wed, 13 May 2015 01:01:40 -0400 Received: (qmail 2136 invoked by uid 102); 13 May 2015 05:01:40 -0000 Received: from Unknown (HELO peff.net) (10.0.1.1) by cloud.peff.net (qpsmtpd/0.84) with SMTP; Wed, 13 May 2015 00:01:40 -0500 Received: (qmail 6985 invoked by uid 107); 13 May 2015 05:01:39 -0000 Received: from sigill.intra.peff.net (HELO sigill.intra.peff.net) (10.0.0.7) by peff.net (qpsmtpd/0.84) with SMTP; Wed, 13 May 2015 01:01:39 -0400 Received: by sigill.intra.peff.net (sSMTP sendmail emulation); Wed, 13 May 2015 01:01:38 -0400 Content-Disposition: inline In-Reply-To: <20150513045650.GA6070@peff.net> Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: Older versions of AsciiDoc would convert the "--" in "--option" into an emdash. According to 565e135 (Documentation: quote double-dash for AsciiDoc, 2011-06-29), this is fixed in AsciiDoc 8.3.0. According to bf17126, we don't support anything older than 8.4.1 anyway, so we no longer need to worry about quoting. Even though this does not change the output at all, there are a few good reasons to drop the quoting: 1. It makes the source prettier to read. 2. We don't quote consistently, which may be confusing when reading the source. 3. Asciidoctor does not like the quoting, and renders a literal backslash. Signed-off-by: Jeff King --- So this is the first of the more questionable patches, simply because we are appeasing Asciidoctor, but not fixing the root problem (i.e., there are still lots of places where the backslash quoting is messed up, like HEAD@\{yesterday}). So I suspect we need to figure that problem out, and then the asciidoctor issues will just go away. However, I think this may be worth doing just to prettify the source. Documentation/config.txt | 10 ++-- Documentation/git-fast-export.txt | 6 +-- Documentation/git-fast-import.txt | 28 +++++------ Documentation/git-fetch-pack.txt | 2 +- Documentation/git-pack-objects.txt | 2 +- Documentation/git-push.txt | 4 +- Documentation/git-rev-list.txt | 96 +++++++++++++++++++------------------- Documentation/git-rev-parse.txt | 2 +- Documentation/git-send-pack.txt | 2 +- Documentation/git-show.txt | 2 +- Documentation/gitdiffcore.txt | 6 +-- 11 files changed, 80 insertions(+), 80 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index 948b8b0..e5d2ace 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -2279,18 +2279,18 @@ remote..skipFetchAll:: remote..receivepack:: The default program to execute on the remote side when pushing. See - option \--receive-pack of linkgit:git-push[1]. + option --receive-pack of linkgit:git-push[1]. remote..uploadpack:: The default program to execute on the remote side when fetching. See - option \--upload-pack of linkgit:git-fetch-pack[1]. + option --upload-pack of linkgit:git-fetch-pack[1]. remote..tagOpt:: - Setting this value to \--no-tags disables automatic tag following when - fetching from remote . Setting it to \--tags will fetch every + Setting this value to --no-tags disables automatic tag following when + fetching from remote . Setting it to --tags will fetch every tag from remote , even if they are not reachable from remote branch heads. Passing these flags directly to linkgit:git-fetch[1] can - override this setting. See options \--tags and \--no-tags of + override this setting. See options --tags and --no-tags of linkgit:git-fetch[1]. remote..vcs:: diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt index 929e496..ed57c68 100644 --- a/Documentation/git-fast-export.txt +++ b/Documentation/git-fast-export.txt @@ -67,17 +67,17 @@ produced incorrect results if you gave these options. have been completed, or to save the marks table across incremental runs. As is only opened and truncated at completion, the same path can also be safely given to - \--import-marks. + --import-marks. The file will not be written if no new object has been marked/exported. --import-marks=:: Before processing any input, load the marks specified in . The input file must exist, must be readable, and - must use the same format as produced by \--export-marks. + must use the same format as produced by --export-marks. + Any commits that have already been marked will not be exported again. -If the backend uses a similar \--import-marks file, this allows for +If the backend uses a similar --import-marks file, this allows for incremental bidirectional exporting of the repository by keeping the marks the same across runs. diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index bf7fbd4..fd32895 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -42,13 +42,13 @@ OPTIONS --quiet:: Disable all non-fatal output, making fast-import silent when it is successful. This option disables the output shown by - \--stats. + --stats. --stats:: Display some basic statistics about the objects fast-import has created, the packfiles they were stored into, and the memory used by fast-import during this run. Showing this output - is currently the default, but can be disabled with \--quiet. + is currently the default, but can be disabled with --quiet. Options for Frontends ~~~~~~~~~~~~~~~~~~~~~ @@ -81,12 +81,12 @@ Locations of Marks Files have been completed, or to save the marks table across incremental runs. As is only opened and truncated at checkpoint (or completion) the same path can also be - safely given to \--import-marks. + safely given to --import-marks. --import-marks=:: Before processing any input, load the marks specified in . The input file must exist, must be readable, and - must use the same format as produced by \--export-marks. + must use the same format as produced by --export-marks. Multiple options may be supplied to import more than one set of marks. If a mark is defined to different values, the last file wins. @@ -179,8 +179,8 @@ fast-forward update, fast-import will skip updating that ref and instead prints a warning message. fast-import will always attempt to update all branch refs, and does not stop on the first failure. -Branch updates can be forced with \--force, but it's recommended that -this only be used on an otherwise quiet repository. Using \--force +Branch updates can be forced with --force, but it's recommended that +this only be used on an otherwise quiet repository. Using --force is not necessary for an initial import into an empty repository. @@ -231,11 +231,11 @@ Date Formats ~~~~~~~~~~~~ The following date formats are supported. A frontend should select the format it will use for this import by passing the format name -in the \--date-format= command-line option. +in the --date-format= command-line option. `raw`:: This is the Git native format and is `