From patchwork Sat Mar 16 15:21:40 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Jean-No=C3=ABl_Avila?= X-Patchwork-Id: 13594446 Received: from mail-wr1-f54.google.com (mail-wr1-f54.google.com [209.85.221.54]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 785EB1B950 for ; Sat, 16 Mar 2024 15:21:46 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.54 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1710602508; cv=none; b=aMhBQl65+WF8/eaEaXgf/dHzA088t/2juMR0kOk2Dp5e28jj47133aAlce7FW2o3bJ7VZ/yymPa7kw8FQK7GpjZJqgwl7dl2U9S6CVEC4W4s9J9BA3/vEArEtRsD36YAppJoazk3qNtJ3dfKuh3U4jOK2FFcBNykNpVoh8j9FNQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1710602508; c=relaxed/simple; bh=oPz7KYealauUVutAcjXrqnXsxeqhtKHs7y09p8I2XAs=; h=Message-ID:In-Reply-To:References:From:Date:Subject:MIME-Version: Content-Type:To:Cc; b=XgqKxvBUdj95ZzZxAa6FK2Zt1XOjzRMs6idaTbsIXr9hQs9COrXq3oTkDNXtHn3rgcO9sDFXb0gzd6RKeAzqvVXyhW5SZh4rTwVreeDi4fvdoRaT8uIhP/EZKJ9ASY1YsPdsYvqomf3Ke+VObrR8wvfMbnr8me0vKDngj3hRxDQ= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=Y10y8Lw1; arc=none smtp.client-ip=209.85.221.54 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="Y10y8Lw1" Received: by mail-wr1-f54.google.com with SMTP id ffacd0b85a97d-34005b5927eso215769f8f.1 for ; Sat, 16 Mar 2024 08:21:46 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1710602504; x=1711207304; darn=vger.kernel.org; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=XFsf3ZoFuQo0W05UGN7ooRECEN9ypBHYE/9gBnciXhk=; b=Y10y8Lw1ZERwOonZr0K+Tl6W14qhivzEBqwymAiXytw4Y9DXEFNpR1j3M+/Uw6pJmU wHOfuiTDh+ScFjWhx5tbMrgg+IoTprEHOsbUICyPVuygbmYyutmn2ceChHyCjmZvjk/4 Wd6+k9xo3mBcNcKLQa04XrsaUAr4JxmsqxbrQbvPEL+HJxFb5zINE+WREsY3rnmkDFb3 EVMQfBB7Guk4lDfTDyXYztJG2wws+UWs94ShzT+96HlBEcPyqamfTAshPNMCfDQwyldv z0dlJ5JkT04ohx3i/ApSRoe8RnXWRIVxfkJAYMYcRjhicAyur0Zv70Xyp9CkdLA/27fu g2Pg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1710602504; x=1711207304; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=XFsf3ZoFuQo0W05UGN7ooRECEN9ypBHYE/9gBnciXhk=; b=pG8HI2oc0sTibsmIH3SQdM8Gj279Xir6cgigtJXnEL+VzAMEHMrds1Xpcq4KF01mjr j3qyAByBfy45bl8l+HTFr2DtEkRihIgyqJUq3AznIlivPb6spf/LOcdK6SRXQe/602SE StRw5Q5J/oBpyXYc1s2nfD5hf3hs29b+KCbOcyQYzfR5yH42VY4WPJ05s+LIkz7h/5/P DmGt4Na7SpVXKUMrDoWCQVXOuhzM1eTfe1O+IQU7n/kpFNSx7lGV7RGxFOoBMWEboMqM aNWOhrxtq1MDoAG3TR5nbIYgi3tNS7GH7w0teoo7OWxe7TVWMHvhXP2IwOiY0AfNinXb Q7Jg== X-Gm-Message-State: AOJu0Yym4GIFAekxqKZYO9EPAfCudrX7aUBs3Vk60NDB0TmCFjfNmHg3 18LdcBDHg1mBZwOB2opsp3AX77+i+i2P2JB3rgnaIDeTSKYF0lRMreoXPLPz X-Google-Smtp-Source: AGHT+IFbIEHXvPGUAKBhHft6TRhK3GuSTA2Gqg3OfsZtvSDbbQMSiRhKcsm6V9uiZIZLYMxOjWE/mg== X-Received: by 2002:adf:f3d2:0:b0:33d:b376:8a07 with SMTP id g18-20020adff3d2000000b0033db3768a07mr4429917wrp.8.1710602503586; Sat, 16 Mar 2024 08:21:43 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id bu27-20020a056000079b00b0033ecbfc6941sm5297128wrb.110.2024.03.16.08.21.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 16 Mar 2024 08:21:43 -0700 (PDT) Message-ID: <2b016b82ab797e95e4acb3dc1ba7010296ac84ca.1710602501.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Sat, 16 Mar 2024 15:21:40 +0000 Subject: [PATCH 1/2] doc: format alternatives in synopsis Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: =?utf-8?q?Jean-No=C3=ABl?= Avila , =?utf-8?q?Jean-No?= =?utf-8?q?=C3=ABl_Avila?= From: =?utf-8?q?Jean-No=C3=ABl_Avila?= From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= This is a list of various fixes on malformed alternative in commands and option syntax. Signed-off-by: Jean-Noël Avila --- Documentation/fetch-options.txt | 2 +- Documentation/git-pull.txt | 4 ++-- Documentation/git-rebase.txt | 2 +- Documentation/git-send-email.txt | 8 +++++--- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt index 54ebb4452e9..e22b217fba9 100644 --- a/Documentation/fetch-options.txt +++ b/Documentation/fetch-options.txt @@ -202,7 +202,7 @@ endif::git-pull[] destination of an explicit refspec; see `--prune`). ifndef::git-pull[] ---recurse-submodules[=yes|on-demand|no]:: +--recurse-submodules[=(yes|on-demand|no)]:: This option controls if and under what conditions new commits of submodules should be fetched too. When recursing through submodules, `git fetch` always attempts to fetch "changed" submodules, that is, a diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt index 0e14f8b5b25..b2ae496e488 100644 --- a/Documentation/git-pull.txt +++ b/Documentation/git-pull.txt @@ -87,7 +87,7 @@ OPTIONS --verbose:: Pass --verbose to git-fetch and git-merge. ---[no-]recurse-submodules[=yes|on-demand|no]:: +--[no-]recurse-submodules[=(yes|on-demand|no)]:: This option controls if new commits of populated submodules should be fetched, and if the working trees of active submodules should be updated, too (see linkgit:git-fetch[1], linkgit:git-config[1] and @@ -105,7 +105,7 @@ Options related to merging include::merge-options.txt[] -r:: ---rebase[=false|true|merges|interactive]:: +--rebase[=(false|true|merges|interactive)]:: When true, rebase the current branch on top of the upstream branch after fetching. If there is a remote-tracking branch corresponding to the upstream branch and the upstream branch diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index e7e725044db..03d5e9936a0 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -12,7 +12,7 @@ SYNOPSIS [--onto | --keep-base] [ []] 'git rebase' [-i | --interactive] [] [--exec ] [--onto ] --root [] -'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch) +'git rebase' (--continue|--skip|--abort|--quit|--edit-todo|--show-current-patch) DESCRIPTION ----------- diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt index 8264f873809..c5d664f4519 100644 --- a/Documentation/git-send-email.txt +++ b/Documentation/git-send-email.txt @@ -9,7 +9,7 @@ git-send-email - Send a collection of patches as emails SYNOPSIS -------- [verse] -'git send-email' [] ... +'git send-email' [] (|)... 'git send-email' [] 'git send-email' --dump-aliases @@ -278,7 +278,7 @@ must be used for each option. if a username is not specified (with `--smtp-user` or `sendemail.smtpUser`), then authentication is not attempted. ---smtp-debug=0|1:: +--smtp-debug=(0|1):: Enable (1) or disable (0) debug output. If enabled, SMTP commands and replies will be printed. Useful to debug TLS connection and authentication problems. @@ -301,7 +301,9 @@ must be used for each option. Automating ~~~~~~~~~~ ---no-[to|cc|bcc]:: +--no-to:: +--no-cc:: +--no-bcc:: Clears any list of "To:", "Cc:", "Bcc:" addresses previously set via config. From patchwork Sat Mar 16 15:21:41 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Jean-No=C3=ABl_Avila?= X-Patchwork-Id: 13594447 Received: from mail-wr1-f45.google.com (mail-wr1-f45.google.com [209.85.221.45]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 0FC311B969 for ; Sat, 16 Mar 2024 15:21:47 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.45 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1710602509; cv=none; b=BbKgky2ScDvCPVDT9JiR8zXzVjTCuHzrBYDNKT/AJeClLS55dBfFYoisCEE+01PJdeYcrsa2haoLvv+2IJPpXh8KuUAkzA2OBDBFLMnypDR+ucFvKF7L6fO9/Dca2p0MWHk4bHr2UJ0Ukl8SX83ueDeS1f8P1GUfZhq5XIgvCTE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1710602509; c=relaxed/simple; bh=41E4QcbIMCNqjbCbA/9iAzSoRB+C3SSxAwSBTWl97l8=; h=Message-ID:In-Reply-To:References:From:Date:Subject:MIME-Version: Content-Type:To:Cc; b=OGNs78nOCWvG+aAwO1oqbwpYgHjp0hB2maeGGkVVpKoCZe+eX3g4oByBlRT170+2WibaOQf4FCMZuBfgsH+Z8A9hC9C3dSsMGWFwzSR/hSYXfPOml03+o5wuVfOlPjRnfNYQoMvfFRMxQS5oww1yuq6GFsKqWBYu8Pma6XFTE10= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=gEQ7PJVx; arc=none smtp.client-ip=209.85.221.45 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="gEQ7PJVx" Received: by mail-wr1-f45.google.com with SMTP id ffacd0b85a97d-34005b5927eso215781f8f.1 for ; Sat, 16 Mar 2024 08:21:47 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1710602505; x=1711207305; darn=vger.kernel.org; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=QHIJpNsetkU4Br0nlen2fLFiPkq+drfSjghprHfFI5Y=; b=gEQ7PJVxgfkoIor73nsMFjdVMZI+qcoAZxWlegFYPDUyi4kBjCMw5snRWCsKmAGQZ8 lL6YKRjzYjo4DohmtDlwvlRu5R6b3+b4VET+GUgrrkxSWfXIGhkp2BwNwGtm569hh9By Dc9kMKwNwXrOe6A1uB+e1ILkTdZVxC48PnIeRqUH3lgXNp1yHXVrc2ZPvDljp/iz8g2o 03PQjSEDJMq6QjGydcKDKyX6gs/0Iu2pgDypUjedEQiIWsuQjyaXX7HuVx+xb0l9spaO uJQFLXpeSfdpf2Q/L+rk93lPBcH+L9lO680PYbEn5I5ZfmAGxepG2aRzsdGRQePFvp8r VgPA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1710602505; x=1711207305; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=QHIJpNsetkU4Br0nlen2fLFiPkq+drfSjghprHfFI5Y=; b=Y20qyk9Oy+VpgWrfMZOzdmSJkOxECu+Apflk3IHNqi2Xz+9hpvIRsVPX2rUsoc/LZ3 GQOr/GgzzArmKuBZlA+REM+a438AlEfiHE3ScxIPm12LiLQ7ufNPekIRxyzA5rqHL3xA ZPrNTfJNBL/d0flF/SPNCgUMJ3eKJS3zT2BlGe62/mtZ4DWfYTwYf1FguiOhvnT/pzMO hbqLnDn1K7x/n5qDPlSkAyhi7lgMmlOQYkN40R6IuGyDlcc0Z6lJSsDzH+6Kgjhu9xX2 w403NvXg23oXE8VGXqGfZSwWHYARsHnGeKcQlx7yg2kcZR84FIrlSlw3S6spnEWPIUeU oOrA== X-Gm-Message-State: AOJu0Yzr1L+bW9Bp+P/fX/Lltdb3yGLTRYMlMqfvZ9+u8c5PfQg5Kp/n XiG374mKRJrwD5ye627CnNWfgdwsZeBib4SUyHArqhKNtbYvcablaPwVUYCm X-Google-Smtp-Source: AGHT+IG3GLdlnmNPgI/7MPSV1QeGUM/FtLkyLiw8zWafA1LFYKMlRtbtblsu8S/hn2F9Od25pBE1Qg== X-Received: by 2002:adf:f20f:0:b0:33e:c0db:441 with SMTP id p15-20020adff20f000000b0033ec0db0441mr5929106wro.7.1710602505467; Sat, 16 Mar 2024 08:21:45 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id p6-20020adff206000000b0033cf5094fcesm5615644wro.36.2024.03.16.08.21.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 16 Mar 2024 08:21:43 -0700 (PDT) Message-ID: <6f4e68170391cc123f77a2994f13cfb6e1c3dce3.1710602501.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Sat, 16 Mar 2024 15:21:41 +0000 Subject: [PATCH 2/2] doc: fix some placeholders formating Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: =?utf-8?q?Jean-No=C3=ABl?= Avila , =?utf-8?q?Jean-No?= =?utf-8?q?=C3=ABl_Avila?= From: =?utf-8?q?Jean-No=C3=ABl_Avila?= From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= Signed-off-by: Jean-Noël Avila --- Documentation/git-interpret-trailers.txt | 6 +++--- Documentation/git.txt | 2 +- Documentation/rev-list-options.txt | 6 +++--- builtin/interpret-trailers.c | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index 418265f044d..d9dfb75fef5 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'git interpret-trailers' [--in-place] [--trim-empty] - [(--trailer (|)[(=|:)])...] + [(--trailer (|)[(=|:)])...] [--parse] [...] DESCRIPTION @@ -67,9 +67,9 @@ key: value This means that the trimmed and will be separated by `': '` (one colon followed by one space). -For convenience, a can be configured to make using `--trailer` +For convenience, a can be configured to make using `--trailer` shorter to type on the command line. This can be configured using the -'trailer..key' configuration variable. The must be a prefix +'trailer..key' configuration variable. The must be a prefix of the full string, although case sensitivity does not matter. For example, if you have diff --git a/Documentation/git.txt b/Documentation/git.txt index e6b766d5c3a..7a1b112a3e7 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -960,7 +960,7 @@ will never be returned from the commit-graph at the cost of performance. `GIT_PROTOCOL`:: For internal use only. Used in handshaking the wire protocol. Contains a colon ':' separated list of keys with optional values - 'key[=value]'. Presence of unknown keys and values must be + '[=]'. Presence of unknown keys and values must be ignored. + Note that servers may need to be configured to allow this variable to diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt index 408d9314d08..00ccf687441 100644 --- a/Documentation/rev-list-options.txt +++ b/Documentation/rev-list-options.txt @@ -316,12 +316,12 @@ list. With `--pretty` format other than `oneline` and `reference` (for obvious reasons), this causes the output to have two extra lines of information taken from the reflog. The reflog designator in the output may be shown -as `ref@{Nth}` (where `Nth` is the reverse-chronological index in the -reflog) or as `ref@{timestamp}` (with the timestamp for that entry), +as `ref@{}` (where __ is the reverse-chronological index in the +reflog) or as `ref@{}` (with the __ for that entry), depending on a few rules: + -- -1. If the starting point is specified as `ref@{Nth}`, show the index +1. If the starting point is specified as `ref@{}`, show the index format. + 2. If the starting point was specified as `ref@{now}`, show the diff --git a/builtin/interpret-trailers.c b/builtin/interpret-trailers.c index 11f4ce9e4a2..8768bfea3c4 100644 --- a/builtin/interpret-trailers.c +++ b/builtin/interpret-trailers.c @@ -15,7 +15,7 @@ static const char * const git_interpret_trailers_usage[] = { N_("git interpret-trailers [--in-place] [--trim-empty]\n" - " [(--trailer (|)[(=|:)])...]\n" + " [(--trailer (|)[(=|:)])...]\n" " [--parse] [...]"), NULL };