From patchwork Fri Apr 9 04:02:58 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Firmin Martin X-Patchwork-Id: 12192995 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.2 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URG_BIZ,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8C0B2C43461 for ; Fri, 9 Apr 2021 04:06:37 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 4DE9C6115C for ; Fri, 9 Apr 2021 04:06:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231431AbhDIEGs (ORCPT ); Fri, 9 Apr 2021 00:06:48 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60988 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231343AbhDIEGG (ORCPT ); Fri, 9 Apr 2021 00:06:06 -0400 Received: from mail-wm1-x331.google.com (mail-wm1-x331.google.com [IPv6:2a00:1450:4864:20::331]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 275B4C061762 for ; Thu, 8 Apr 2021 21:05:53 -0700 (PDT) Received: by mail-wm1-x331.google.com with SMTP id 5-20020a05600c0245b029011a8273f85eso2235586wmj.1 for ; Thu, 08 Apr 2021 21:05:53 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=XSvqG8WXUr/rx6+U8SaX4nPnhmnv11TaK9gan1tFma8=; b=dcxUdGmu/cwWJt4rzsWVmobElaiqAUhr+bnFlrrPVEVojamWFO9MN43D9ZgvNZCMS4 g0G9wSOSm2mYKkmJ7zMK0Ceagf0ehJJoJhzUwuXLKEvHlHBKsHtRdEh4TWNT+GcR+U3L DaMhfOsmJd/ic1mnhnNhd+JHU4+I/xTKGhzH2DlFyED8xTe4qtaEIMXcw4D6lib1pV9E jfcOFhsPlLvQdmN5eX1pkkMv7omFtasgP9HxWpqwWPJMGzLoT0883zEXv47BmTlkmozU q3pBmIr3YMz7tfT/rk7vYhXp7k7PjYd/K0RFC/zl5iwSlDmnpwVObwcFLgeRsJ/CwAvJ gaRQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=XSvqG8WXUr/rx6+U8SaX4nPnhmnv11TaK9gan1tFma8=; b=FPZ4uUz11Ytv1eITCQb4wxuuX68BWDKeN4nlwX1IN89fGRlhGQ4nEzNCV2kw39m+vN oNFZzQsdw8eBjIPT2N13J30a9VOMg0pwJvJEPdEXOMCS3xgAsy23oScHIz0NQ9u3AkCY rQRM0e7H48sZ9cPwHi4ei1Wxq8p5Q0Dob0DUop3MofWvrdhmUaQHfuhNbbmX+7Fg9CD3 Joi7EhAcLBfeL1YC0bpYqbNX4zbixmml6VcgCcP96tGGI0iz19dx06P3iv2CVeM5I+4u Zh/ndl4qmvyStPowjQcq8fncF5RhPop5zwA2TBKew4fMbjFGcUWKR/wClC/lxtLpTSyl BL6A== X-Gm-Message-State: AOAM532g11GZmF9hLcVtghptc9qJLGRMmot4C0nb5qAsI9MvN+KXWWu0 H2h6km3z5L2SN3C7H+RCvHK3GTfG3MiKfQ== X-Google-Smtp-Source: ABdhPJyqoQ43H0OMtOrOzBmFHCF+0I7qlCGMwCaHcp12qUuq2g2Ex/pPO9gerEHixsa4K15rVSIe1g== X-Received: by 2002:a1c:2541:: with SMTP id l62mr11764772wml.188.1617941150415; Thu, 08 Apr 2021 21:05:50 -0700 (PDT) Received: from Inspiron.home (2a01cb04010c420080e637770dc2ae3c.ipv6.abo.wanadoo.fr. [2a01:cb04:10c:4200:80e6:3777:dc2:ae3c]) by smtp.gmail.com with ESMTPSA id c9sm2064636wrr.78.2021.04.08.21.05.49 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 08 Apr 2021 21:05:49 -0700 (PDT) From: Firmin Martin To: git@vger.kernel.org Cc: Firmin Martin Subject: [RFC PATCH v1 10/13] doc: typeset more command entries in monospace Date: Fri, 9 Apr 2021 06:02:58 +0200 Message-Id: <20210409040301.3260358-11-firminmartin24@gmail.com> X-Mailer: git-send-email 2.31.1.133.g84d06cdc06 In-Reply-To: <20210409040301.3260358-1-firminmartin24@gmail.com> References: <20210409040301.3260358-1-firminmartin24@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Wrap command-line option entries (i.e. something of the form [::|;;]) which contain space or number with backticks as indicated in the CodingGuidelines. Additionaly, as an intended effect, also wrap some subcommands and status values. The following command and regex assisted the substitution with manual intervention to exclude false positives. REGEX="^([[:space:]]*?)[\"']?([][ 0-9a-zA-Z-=<>]+)[\"']?(::|;;)([[:space:]]+|\$)" && perl -pi -e "s/$REGEX/\$1\`\$2\`\$3\$4/g" $(grep -Pl "$REGEX" *.txt --exclude-dir=RelNotes) Signed-off-by: Firmin Martin --- Documentation/blame-options.txt | 10 ++++----- Documentation/diff-format.txt | 4 ++-- Documentation/fetch-options.txt | 12 +++++------ Documentation/git-add.txt | 2 +- Documentation/git-am.txt | 10 ++++----- Documentation/git-apply.txt | 4 ++-- Documentation/git-archimport.txt | 4 ++-- Documentation/git-archive.txt | 6 +++--- Documentation/git-branch.txt | 14 ++++++------- Documentation/git-bugreport.txt | 8 ++++---- Documentation/git-bundle.txt | 8 ++++---- Documentation/git-check-ignore.txt | 6 +++--- Documentation/git-cherry-pick.txt | 4 ++-- Documentation/git-clean.txt | 8 ++++---- Documentation/git-clone.txt | 26 ++++++++++++------------ Documentation/git-column.txt | 14 ++++++------- Documentation/git-commit-tree.txt | 6 +++--- Documentation/git-commit.txt | 10 ++++----- Documentation/git-config.txt | 16 +++++++-------- Documentation/git-credential-cache.txt | 4 ++-- Documentation/git-credential-store.txt | 2 +- Documentation/git-cvsexportcommit.txt | 2 +- Documentation/git-cvsimport.txt | 24 +++++++++++----------- Documentation/git-cvsserver.txt | 2 +- Documentation/git-describe.txt | 4 ++-- Documentation/git-diff-files.txt | 8 ++++---- Documentation/git-diff.txt | 8 ++++---- Documentation/git-difftool.txt | 4 ++-- Documentation/git-filter-branch.txt | 24 +++++++++++----------- Documentation/git-fmt-merge-msg.txt | 8 ++++---- Documentation/git-for-each-repo.txt | 2 +- Documentation/git-format-patch.txt | 12 +++++------ Documentation/git-fsck.txt | 8 ++++---- Documentation/git-grep.txt | 18 ++++++++-------- Documentation/git-hash-object.txt | 2 +- Documentation/git-http-fetch.txt | 2 +- Documentation/git-index-pack.txt | 2 +- Documentation/git-init.txt | 6 +++--- Documentation/git-interpret-trailers.txt | 6 +++--- Documentation/git-log.txt | 2 +- Documentation/git-ls-files.txt | 4 ++-- Documentation/git-ls-remote.txt | 2 +- Documentation/git-merge-file.txt | 4 ++-- Documentation/git-merge.txt | 4 ++-- Documentation/git-mergetool.txt | 2 +- Documentation/git-notes.txt | 12 +++++------ Documentation/git-p4.txt | 22 ++++++++++---------- Documentation/git-prune.txt | 2 +- Documentation/git-push.txt | 14 ++++++------- Documentation/git-quiltimport.txt | 6 +++--- Documentation/git-range-diff.txt | 4 ++-- Documentation/git-rebase.txt | 10 ++++----- Documentation/git-receive-pack.txt | 2 +- Documentation/git-replace.txt | 6 +++--- Documentation/git-reset.txt | 6 +++--- Documentation/git-restore.txt | 2 +- Documentation/git-rev-parse.txt | 8 ++++---- Documentation/git-revert.txt | 4 ++-- Documentation/git-send-email.txt | 2 +- Documentation/git-shell.txt | 2 +- Documentation/git-shortlog.txt | 2 +- Documentation/git-show-branch.txt | 2 +- Documentation/git-show-index.txt | 2 +- Documentation/git-stash.txt | 4 ++-- Documentation/git-submodule.txt | 14 ++++++------- Documentation/git-svn.txt | 16 +++++++-------- Documentation/git-switch.txt | 10 ++++----- Documentation/git-tag.txt | 16 +++++++-------- Documentation/git-unpack-file.txt | 2 +- Documentation/git-update-index.txt | 4 ++-- Documentation/git-upload-archive.txt | 2 +- Documentation/git-web--browse.txt | 8 ++++---- Documentation/git-worktree.txt | 10 ++++----- Documentation/git.txt | 4 ++-- Documentation/gitattributes.txt | 2 +- Documentation/gitk.txt | 2 +- Documentation/gitremote-helpers.txt | 10 ++++----- Documentation/gitweb.txt | 4 ++-- Documentation/merge-options.txt | 4 ++-- Documentation/pull-fetch-param.txt | 6 +++--- Documentation/rev-list-options.txt | 6 +++--- Documentation/revisions.txt | 2 +- 82 files changed, 286 insertions(+), 286 deletions(-) diff --git a/Documentation/blame-options.txt b/Documentation/blame-options.txt index c58d30a648..15e50af424 100644 --- a/Documentation/blame-options.txt +++ b/Documentation/blame-options.txt @@ -26,7 +26,7 @@ include::line-range-format.txt[] `-t`:: Show raw timestamp (Default: off). --S :: +`-S `:: Use revisions from revs-file instead of calling linkgit:git-rev-list[1]. --reverse ..:: @@ -63,14 +63,14 @@ include::line-range-format.txt[] discussion about encoding in the linkgit:git-log[1] manual page. ---contents :: +`--contents `:: When is not specified, the command annotates the changes starting backwards from the working tree copy. This flag makes the command pretend as if the working tree copy has the contents of the named file (specify `-` to make the command read from the standard input). ---date :: +`--date `:: Specifies the format used to output dates. If `--date` is not provided, the value of the `blame.date` config variable is used. If the `blame.date` config variable is also not set, the @@ -117,7 +117,7 @@ commit. And the default value is 40. If there are more than one `-C` options given, the argument of the last `-C` will take effect. ---ignore-rev :: +`--ignore-rev `:: Ignore changes made by the revision when assigning blame, as if the change never happened. Lines that were changed or added by an ignored commit will be blamed on the previous commit that changed that line or @@ -129,7 +129,7 @@ take effect. by an ignored commit that we could not attribute to another revision are marked with a '*'. ---ignore-revs-file :: +`--ignore-revs-file `:: Ignore revisions listed in `file`, which must be in the same format as an `fsck.skipList`. This option may be repeated, and these files will be processed after any files specified with the `blame.ignoreRevsFile` config diff --git a/Documentation/diff-format.txt b/Documentation/diff-format.txt index 14ef11d552..ac0ecc266a 100644 --- a/Documentation/diff-format.txt +++ b/Documentation/diff-format.txt @@ -7,10 +7,10 @@ The raw output format from `git-diff-index`, `git-diff-tree`, These commands all compare two sets of things; what is compared differs: -git-diff-index :: +`git-diff-index `:: compares the and the files on the filesystem. -git-diff-index --cached :: +`git-diff-index --cached `:: compares the and the index. git-diff-tree [-r] [...]:: diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt index fcee0ad87d..98ffc052f0 100644 --- a/Documentation/fetch-options.txt +++ b/Documentation/fetch-options.txt @@ -231,7 +231,7 @@ ifndef::git-pull[] use it. endif::git-pull[] ---upload-pack :: +`--upload-pack `:: When given, and the repository to fetch from is handled by `git fetch-pack`, `--exec=` is passed to the command to specify non-default path for the command @@ -255,7 +255,7 @@ endif::git-pull[] is specified. This flag forces progress status even if the standard error stream is not directed to a terminal. --o