From patchwork Mon May 15 12:13:08 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Allred X-Patchwork-Id: 13241311 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 927B4C7EE23 for ; Mon, 15 May 2023 12:13:45 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S241215AbjEOMNo (ORCPT ); Mon, 15 May 2023 08:13:44 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42354 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S241385AbjEOMNk (ORCPT ); Mon, 15 May 2023 08:13:40 -0400 Received: from mail-wm1-x32c.google.com (mail-wm1-x32c.google.com [IPv6:2a00:1450:4864:20::32c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 900C21BF6 for ; Mon, 15 May 2023 05:13:17 -0700 (PDT) Received: by mail-wm1-x32c.google.com with SMTP id 5b1f17b1804b1-3f50020e0f8so49433595e9.0 for ; Mon, 15 May 2023 05:13:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1684152796; x=1686744796; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=/wqUfnFSVgSGtMqbFzJtE6fjkpqa7mDc9RPSfZp97QM=; b=h8SlBbz1XcixuSiRfoThJdN7GPLY42OnfzScc75ciIJdHFx+qMCOFO1ghvvQdFk/0j DBEzkbjwLJvOKEeIwDVu5fDGRqDYj/Gy8DT1uo1jNJMvoM3k2VETDqvA2rycPDrE30XZ CvF47bauvQR9f+GfsoZ+cOix3PRH03+PI5m+5C/PQUO10cZR4FvVyEGSIw6DcCBCF4yv P4rdHJIdo/54b3BcIJ9Ye/5BTayOkcVNtuzqNXr+GuaEOe3oAfiuk0/R/Qsu5ro9+/t3 S1L053GeZ30a6AB+HGPZ8pOZe7UCZ07ONNlBcfywS/ywJbGrc5gndxRLjAlUnjvHAfqA vk1Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684152796; x=1686744796; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=/wqUfnFSVgSGtMqbFzJtE6fjkpqa7mDc9RPSfZp97QM=; b=EAc5KT28vPUq8xDccsryxbyrTUaynHvh+usYhzKrvWTVk/HRKKzN2t7jcs/FLAF7hL vDiJinz8PCCaKY2DHRn3eg4KkRMg8gOBXS87gBQ1cDVJpDhOgVwSaVll1e4yXWHOdu7Q H31ZTypXZnuHUQaPECNd+ydlWXidGONtsgany0e185crBZ6cjvCIEwdLlA8AtTTVe9fB oI42LnkfYwgtozahRzn4AnezOn2ObVRz9f2cAJ68vZZa1t2A675az3CT5CIYf9nyzkMr sObJmqwc3a0yKAAk8WvzpszZPQnyQXr6vTTvw0SZuuUTv3TaR5eh+aaJH49Mw9wpmNop c/2w== X-Gm-Message-State: AC+VfDwtVHEDvMzh3Th2CcPuuctNS3RXkyFEsZi5JT0QMfnDgqX8cjZr bqvHNlXPKryU1TLf7JSC8HXYwtyY3CE= X-Google-Smtp-Source: ACHHUZ58r25IYB5n8KUChfWA2qLpFw28U6Y7+Kc5bkv1xvkEG//avr1XlJ5URncm08Rgs4ngno+Krw== X-Received: by 2002:adf:dfc7:0:b0:307:c0c4:1094 with SMTP id q7-20020adfdfc7000000b00307c0c41094mr12777020wrn.34.1684152795342; Mon, 15 May 2023 05:13:15 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id n10-20020a5d400a000000b00307a3045d65sm20478473wrp.46.2023.05.15.05.13.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 15 May 2023 05:13:15 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Mon, 15 May 2023 12:13:08 +0000 Subject: [PATCH v3 1/6] show-ref doc: update for internal consistency Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Eric Sunshine , Sean Allred , Sean Allred , Sean Allred Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Sean Allred From: Sean Allred - Use inline-code syntax for options where appropriate. - Use code blocks to clarify output format. This patch also swaps out 'SHA-1' language for the implementation- agnostic 'OID' term where appropriate in preparation for supporting different hashing algorithms. Signed-off-by: Sean Allred --- Documentation/git-show-ref.txt | 40 ++++++++++++++++++++++------------ 1 file changed, 26 insertions(+), 14 deletions(-) diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt index d1d56f68b43..be048bf1816 100644 --- a/Documentation/git-show-ref.txt +++ b/Documentation/git-show-ref.txt @@ -23,7 +23,7 @@ particular ref exists. By default, shows the tags, heads, and remote refs. -The --exclude-existing form is a filter that does the inverse. It reads +The `--exclude-existing` form is a filter that does the inverse. It reads refs from stdin, one ref per line, and shows those that don't exist in the local repository. @@ -47,14 +47,14 @@ OPTIONS -d:: --dereference:: - Dereference tags into object IDs as well. They will be shown with "{caret}{}" + Dereference tags into object IDs as well. They will be shown with `{caret}{}` appended. -s:: --hash[=]:: - Only show the SHA-1 hash, not the reference name. When combined with - --dereference the dereferenced tag will still be shown after the SHA-1. + Only show the OID, not the reference name. When combined with + `--dereference`, the dereferenced tag will still be shown after the OID. --verify:: @@ -70,15 +70,15 @@ OPTIONS -q:: --quiet:: - Do not print any results to stdout. When combined with `--verify` this + Do not print any results to stdout. When combined with `--verify`, this can be used to silently check if a reference exists. --exclude-existing[=]:: - Make 'git show-ref' act as a filter that reads refs from stdin of the - form "`^(?:\s)?(?:\^{})?$`" + Make `git show-ref` act as a filter that reads refs from stdin of the + form `^(?:\s)?(?:\^{})?$` and performs the following actions on each: - (1) strip "{caret}{}" at the end of line if any; + (1) strip `{caret}{}` at the end of line if any; (2) ignore if pattern is provided and does not head-match refname; (3) warn if refname is not a well-formed refname and skip; (4) ignore if refname is a ref that exists in the local repository; @@ -96,7 +96,13 @@ OPTIONS OUTPUT ------ -The output is in the format: '' '' ''. +The output is in the format: + +------------ + SP LF +------------ + +For example, ----------------------------------------------------------------------------- $ git show-ref --head --dereference @@ -110,7 +116,13 @@ $ git show-ref --head --dereference ... ----------------------------------------------------------------------------- -When using --hash (and not --dereference) the output format is: '' +When using `--hash` (and not `--dereference`), the output is in the format: + +------------ + LF +------------ + +For example, ----------------------------------------------------------------------------- $ git show-ref --heads --hash @@ -142,10 +154,10 @@ When using the `--verify` flag, the command requires an exact path: will only match the exact branch called "master". -If nothing matches, 'git show-ref' will return an error code of 1, +If nothing matches, `git show-ref` will return an error code of 1, and in the case of verification, it will show an error message. -For scripting, you can ask it to be quiet with the "--quiet" flag, which +For scripting, you can ask it to be quiet with the `--quiet` flag, which allows you to do things like ----------------------------------------------------------------------------- @@ -157,11 +169,11 @@ to check whether a particular branch exists or not (notice how we don't actually want to show any results, and we want to use the full refname for it in order to not trigger the problem with ambiguous partial matches). -To show only tags, or only proper branch heads, use "--tags" and/or "--heads" +To show only tags, or only proper branch heads, use `--tags` and/or `--heads` respectively (using both means that it shows tags and heads, but not other random references under the refs/ subdirectory). -To do automatic tag object dereferencing, use the "-d" or "--dereference" +To do automatic tag object dereferencing, use the `-d` or `--dereference` flag, so you can do ----------------------------------------------------------------------------- From patchwork Mon May 15 12:13:09 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Junio C Hamano X-Patchwork-Id: 13241310 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id E7191C7EE22 for ; Mon, 15 May 2023 12:13:43 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S241529AbjEOMNm (ORCPT ); Mon, 15 May 2023 08:13:42 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42344 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S241346AbjEOMNk (ORCPT ); Mon, 15 May 2023 08:13:40 -0400 Received: from mail-wr1-x434.google.com (mail-wr1-x434.google.com [IPv6:2a00:1450:4864:20::434]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0EB061FC3 for ; Mon, 15 May 2023 05:13:18 -0700 (PDT) Received: by mail-wr1-x434.google.com with SMTP id ffacd0b85a97d-30796c0cbcaso8998873f8f.1 for ; Mon, 15 May 2023 05:13:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1684152796; x=1686744796; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=+EX9LtBIJU7ApbRd/VXHaVpi3R2zVjemKHKAo2nnI0E=; b=DL8ujPPBpd1G8xmjzg4lPhM+uzvd6OUO3zcp/dNNPAzvlKocZS+6TpUEI29dque6eO h/Ty2KiWstVmfktPFIrYK3I3hf+/w0dj//RUZX0VUUuiKOiEYTw3bl4dgU6ypqhF4U5s PZcyVfCkraxKkpWSEkjpBYztivKXvJYEdfj/gsWvMmvRdd9aWCcpFykZPlHiQmNuUwFp ZDxYOdmPU4W5tHSyhv8jDVZBfyUjF8uodWfqdyIQKdDn5uliLWsANdL3zOnRIy9JfrtL CnpRUDd8pWRAdQhgWLQTiKJs6FMwS9KBSfPi5KVBTeDFX8Uu9/WQzXJe4z9DspOkGzxn Q9rg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684152796; x=1686744796; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=+EX9LtBIJU7ApbRd/VXHaVpi3R2zVjemKHKAo2nnI0E=; b=V+/426V+GSzxJVXpVzw464U8o89ni7/RvCS1uRIRsJnPfYqCRESBJLNzxGiKYArXaU 0uT4fiW2bAKcpGnRQSvyUXu1Ezpm7MMMAgY6D3k7KdaYhkKrzPsEGFJdxeAKvCWdH4D3 lpv2SJY2ptsZbkR8VdorVDLZFeJuUL51qRDz1uo/lEz+Jl3GnhEC4LQ+KylzRTGa3b5D QLIZEdXGRodnhhecDCspN+hDemU7fR8GdoBfSFnGDX9NAPL6410ITMBIWEKbZt3ttS+9 3byhx0kf7LyeuNQYWy6LxwnEFFKgNKoHCHsljHWA4Zq6cC1s1207DjDcS93g1sz1lH9W /IxA== X-Gm-Message-State: AC+VfDzjQA9nkinZtWUqqCY6R/d2n2CJdZq8Cfha2YoMEJAQBkzYRNUJ rt991DoEiT4+QAvQG/8jB81g+f/Yv90= X-Google-Smtp-Source: ACHHUZ5qRTZ6XqiyGmaofL3cTqHdPjKJKJn0eRS+QKEigXvijhMSe8JnlQFllLta0752LKahsw99fA== X-Received: by 2002:a5d:6606:0:b0:2ef:b123:46d9 with SMTP id n6-20020a5d6606000000b002efb12346d9mr24629929wru.3.1684152795962; Mon, 15 May 2023 05:13:15 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id n10-20020a5d400a000000b00307a3045d65sm20478492wrp.46.2023.05.15.05.13.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 15 May 2023 05:13:15 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Mon, 15 May 2023 12:13:09 +0000 Subject: [PATCH v3 2/6] show-branch doc: say , not Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Eric Sunshine , Sean Allred , Sean Allred , Junio C Hamano Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Junio C Hamano From: Junio C Hamano The glossary defines 'ref' as the official name of the thing, and the output from "git grep -e ', not . In addition, the page already says in its SYNOPSIS section for the command when it is used in the mode to follow the reflogs. Strictly speaking, many references of these should be updated to after adding an explanation on how these s are discovered (i.e. we take , , or and starting from these commits, follow their ancestry or reflog entries to list commits), but that would be a lot bigger change I would rather not to do in this patch, whose primary purpose is to make the existing documentation more consistent. Signed-off-by: Junio C Hamano Signed-off-by: Sean Allred --- Documentation/git-show-branch.txt | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt index 71f608b1ff1..58cf6210cde 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@ -74,8 +74,7 @@ OPTIONS that is the common ancestor of all the branches. This flag tells the command to go more common commits beyond that. When is negative, display only the - s given, without showing the commit ancestry - tree. + s given, without showing the commit ancestry tree. --list:: Synonym to `--more=-1` @@ -88,8 +87,8 @@ OPTIONS the case of three or more commits. --independent:: - Among the s given, display only the ones that - cannot be reached from any other . + Among the s given, display only the ones that cannot be + reached from any other . --no-name:: Do not show naming strings for each commit. @@ -132,10 +131,11 @@ are mutually exclusive. OUTPUT ------ -Given N , the first N lines are the one-line -description from their commit message. The branch head that is -pointed at by $GIT_DIR/HEAD is prefixed with an asterisk `*` -character while other heads are prefixed with a `!` character. + +Given N s, the first N lines are the one-line description from +their commit message. The branch head that is pointed at by +$GIT_DIR/HEAD is prefixed with an asterisk `*` character while other +heads are prefixed with a `!` character. Following these N lines, one-line log for each commit is displayed, indented N places. If a commit is on the I-th From patchwork Mon May 15 12:13:10 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Allred X-Patchwork-Id: 13241312 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 86DE2C77B7D for ; Mon, 15 May 2023 12:13:47 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S241554AbjEOMNq (ORCPT ); Mon, 15 May 2023 08:13:46 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42360 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S241390AbjEOMNk (ORCPT ); Mon, 15 May 2023 08:13:40 -0400 Received: from mail-wm1-x32a.google.com (mail-wm1-x32a.google.com [IPv6:2a00:1450:4864:20::32a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9AE731730 for ; Mon, 15 May 2023 05:13:18 -0700 (PDT) Received: by mail-wm1-x32a.google.com with SMTP id 5b1f17b1804b1-3f4271185daso83881715e9.2 for ; Mon, 15 May 2023 05:13:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1684152796; x=1686744796; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=tIPYq4PA1KX0c36qFM5WGLdC7UVemm99SyJXwA01oT0=; b=KxAZ7unPRDnDJV9VyjD7SQvmhs6z7bGGE5vIIc5jZIuggv5LgTWiWxl+jfP8IDQlIR UtP+B3qAKTND5YFbHXt52G005lZRdONOHQkxHdbOQHf5JZDSem6dG/yUMvjgJCWVJn+R qQxN05etx15LUR5gZNTxJiBLGu5M96EkETKJ9HlOrTdEPdp/hY5qFzqJYdMEC5CinAwL /3AXkVzuud6Nk8jn+1VBny0yF/Un6uIiTzut3ajaFwXE2cPzDqZ8K09kWIT+3wUFWVSs RU9e+iWKsYk064Z8IQhGzn/wX2uukhOdYCvog5xdZI2BqHjMf1K8/QXKiykGsqUSaXHk LcPw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684152796; x=1686744796; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=tIPYq4PA1KX0c36qFM5WGLdC7UVemm99SyJXwA01oT0=; b=NjTM4DKz69UfLhhNl1ZDED09qOGn88gzKNd7pWGv8gr9I+p8s/BnjxVGZiOL4mmqVz FRxBL5jMOfnq0J/Gy/MK5g6grmcaoKP4I02B81025U94xB4JBc4vRJBxlfq5/QpJklb1 FCgtwPJTYl0kIbZxV2gzyxOW8TC7ZEj2cuy09SXUfiiDILsZMOL4Om8gFT1ROHSIYmRN vrYD7lEINwmK+5rDPsQ+CGKBsAy7TopRNSrFtQBnwwGVeQCRTw0yPMT1YfBAuXA9+P0t eGAyq7XT9sKskM1Sff0UEp6BqoXkdArRqsjdu82QpQ7g8ISLIlsarVFbkzNy4uvqyyDg nj2g== X-Gm-Message-State: AC+VfDwBu3lvsvGeWN5aKJMxmx9Jb92hm3b9gBC8wdnmy8CuGT67C7jy wDB5bBQfNrUJ6/IG5hf3SmK6Z1CV/i8= X-Google-Smtp-Source: ACHHUZ5DZv2SBsIhxDggzxdrABldbGUKfWpCY7yCFBTRXFIsbUDPHufGfQMFMnAm+pnTF/elOLlIDA== X-Received: by 2002:a7b:c316:0:b0:3f1:93c2:4df7 with SMTP id k22-20020a7bc316000000b003f193c24df7mr23512096wmj.5.1684152796513; Mon, 15 May 2023 05:13:16 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id f8-20020a7bc8c8000000b003f4e8530696sm13204280wml.46.2023.05.15.05.13.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 15 May 2023 05:13:16 -0700 (PDT) Message-Id: <8b644fb12038ccaf8967fb04d73c0fe94bd004bb.1684152793.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Mon, 15 May 2023 12:13:10 +0000 Subject: [PATCH v3 3/6] ls-remote doc: remove redundant --tags example Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Eric Sunshine , Sean Allred , Sean Allred , Sean Allred Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Sean Allred From: Sean Allred The --tags option is already demonstrated in the later example that lists version-patterned tags. As it doesn't appear to add anything to the documentation, it ought to be removed to keep the documentation easier to read. Signed-off-by: Sean Allred --- Documentation/git-ls-remote.txt | 7 ------- 1 file changed, 7 deletions(-) diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt index ff3da547ddb..af71cf4a92d 100644 --- a/Documentation/git-ls-remote.txt +++ b/Documentation/git-ls-remote.txt @@ -100,13 +100,6 @@ EXAMPLES -------- ---- -$ git ls-remote --tags . -d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99 -f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1 -7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3 -c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2 -0918385dbd9656cab0d1d81ba7453d49bbc16250 refs/tags/junio-gpg-pub - $ git ls-remote http://www.kernel.org/pub/scm/git/git.git master seen rc 5fe978a5381f1fbad26a80e682ddd2a401966740 refs/heads/master c781a84b5204fb294c9ccc79f8b3baceeb32c061 refs/heads/seen From patchwork Mon May 15 12:13:11 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Allred X-Patchwork-Id: 13241314 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id AAECDC7EE23 for ; Mon, 15 May 2023 12:13:51 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S241571AbjEOMNu (ORCPT ); Mon, 15 May 2023 08:13:50 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42302 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230342AbjEOMNl (ORCPT ); Mon, 15 May 2023 08:13:41 -0400 Received: from mail-wm1-x334.google.com (mail-wm1-x334.google.com [IPv6:2a00:1450:4864:20::334]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 08DE0E67 for ; Mon, 15 May 2023 05:13:19 -0700 (PDT) Received: by mail-wm1-x334.google.com with SMTP id 5b1f17b1804b1-3f41dceb9d4so95390525e9.1 for ; Mon, 15 May 2023 05:13:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1684152797; x=1686744797; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=uT6jl+hfZy+5jBejVeoGS17KRh0aHKd4GnSV24Icj4M=; b=j1Bb3pcB6KPkBYQh4TbgYY4AcmM0oMZlXX1P33lJVGnGaDwQsFK4qXANc8XuDrxugm PP+ZIyG8ybSixMUx1weglRnfYGHCu3So7QO9vP11tbK1VRZNq4opzWnRCc8l3ytslP/M RYBBIfX7/RpIJx96pEpp2LLQhSjgQrqjrSNEs1BI/D25n7w1uSrOk267IZs/nRDMjO0x aO6vJ5z7zm0aP+fqsg4IiaT2xBAuXEG+nwnde7EFwC15OQLbDJ0lHSnuHOGzNVBnKKxG h9Zxr+R/mKd+Vn3DrBFwF1ZMcJ0XxpvAaSiIrNxZEBiylooT+Ql4ScwWsLM/5Mq2/L4l GkUQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684152797; x=1686744797; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=uT6jl+hfZy+5jBejVeoGS17KRh0aHKd4GnSV24Icj4M=; b=e6eazjrB2HeapuM3xd4HRMazhscTJBrx5xYfedRNPKJu9EN60/C/r3AMBV58DNXl1a ES6/2dD/9Qm+QC1isVtuOpv0Q71yQJX1MQdmBDlxA/kl7PEE1++/OC648zcUZYvAXrNT mlt3wqfDa1jXHXg/YuFgY2in5NQldgImjkTxbOLPmt9z0/C4Y2Meh9rmsXzGel8NUqjQ WXiEkHzD89jdgZxPcWzE+lGFHggKEEa2Iy3h/f7tl7Zj0pZefrVZDRot4E8pecjJ2b5v OoR/LIs7GYMcnMnIe46NUy0FVxCtXokMCfrRnRdARyjFdjsyIGaOvRawvic+xZLgmkJs AGCQ== X-Gm-Message-State: AC+VfDyexGL7UZOt3ua7muokLl8jMVUAHm+tLGdEyUofldmiAtA2iDf5 4Tfz0p+63zYAi/kWuWPQktXQ30SVF2k= X-Google-Smtp-Source: ACHHUZ5hvkZFspu+58oxbpbz9E0uO+luItrINdaHPsqvu57UzMGhqWs4EFyUu/U700VJkM3HA2GXJg== X-Received: by 2002:a05:600c:2191:b0:3f4:1a97:ab1d with SMTP id e17-20020a05600c219100b003f41a97ab1dmr24340481wme.1.1684152797051; Mon, 15 May 2023 05:13:17 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id j15-20020a05600c1c0f00b003f1738d0d13sm28318034wms.1.2023.05.15.05.13.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 15 May 2023 05:13:16 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Mon, 15 May 2023 12:13:11 +0000 Subject: [PATCH v3 4/6] ls-remote doc: show peeled tags in examples Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Eric Sunshine , Sean Allred , Sean Allred , Sean Allred Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Sean Allred From: Sean Allred Without `--refs`, this command will show peeled tags. Make this clearer in the examples to further mitigate the possibility of surprises in consuming scripts. Signed-off-by: Sean Allred --- Documentation/git-ls-remote.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt index af71cf4a92d..aabc1a7b90b 100644 --- a/Documentation/git-ls-remote.txt +++ b/Documentation/git-ls-remote.txt @@ -106,10 +106,10 @@ c781a84b5204fb294c9ccc79f8b3baceeb32c061 refs/heads/seen $ git remote add korg http://www.kernel.org/pub/scm/git/git.git $ git ls-remote --tags korg v\* -d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99 -f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1 -c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2 -7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3 +485a869c64a68cc5795dd99689797c5900f4716d refs/tags/v2.39.2 +cbf04937d5b9fcf0a76c28f69e6294e9e3ecd7e6 refs/tags/v2.39.2^{} +d4ca2e3147b409459955613c152220f4db848ee1 refs/tags/v2.40.0 +73876f4861cd3d187a4682290ab75c9dccadbc56 refs/tags/v2.40.0^{} ---- SEE ALSO From patchwork Mon May 15 12:13:12 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Allred X-Patchwork-Id: 13241313 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 90CA4C77B7D for ; Mon, 15 May 2023 12:13:50 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S241565AbjEOMNr (ORCPT ); Mon, 15 May 2023 08:13:47 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42380 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S241379AbjEOMNl (ORCPT ); Mon, 15 May 2023 08:13:41 -0400 Received: from mail-wr1-x429.google.com (mail-wr1-x429.google.com [IPv6:2a00:1450:4864:20::429]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BAF65E65 for ; Mon, 15 May 2023 05:13:19 -0700 (PDT) Received: by mail-wr1-x429.google.com with SMTP id ffacd0b85a97d-307664010fdso11998579f8f.0 for ; Mon, 15 May 2023 05:13:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1684152798; x=1686744798; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=tZcciXW4bVnfpjmGETKlCSrBasg/mBXiWS+E+hIM5QU=; b=UrY521e4xfuwRQD1TlW7KQaOHn4ktlipl/qkmE1YadiywkldK0FAFFXr/Nyvxp4NUj 2wZmNlVj5DZ+187P5yRYwkfmRASSUp7d2UWvei01g53f2qqt76dGhdp5h8WXzFnijrqN RoiK1sPxWsFHlXMOAzp1pcl/M5iN4wb5E4b+ev2Gril0vX7FmtL2JfUuc3Pa3NiS3Vts LhC8+jj7fMmQXwqYfg0QquHMJalcpmFRBiP4dcUhizSW5/IPW2HX37trqWoHnLOzx4KG YC85yejIr4Vpv78y1LQoNRm6+9ezUVIFFc9jbFC/KQ4bfp7q6WbQYY7f5LU6fyN76XS+ h0Wg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684152798; x=1686744798; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=tZcciXW4bVnfpjmGETKlCSrBasg/mBXiWS+E+hIM5QU=; b=I8vEJJCFalD+QX3sgKQacr7GhRYqGPziuow6Vgnnj67zEcVogFd4I3q96AafyYdAk+ ZJKWlkVxwhB1J6ZGPDEeBuaYA/T9JrmHRMBw/EoFoVYaBw66+KSVlfAbqixbvmyUBDlx 69EKTH/5x46hssEMzUAyfqTObQlZH1UKmiXjoxocpH23MEwj0uZ2iwpFE/FAs5sckYfq X6UCaNbXbQApas3BXAGwrMHV1XLD+W056JHB++olLIBdGNDVLUi0DXXC7jBohtP4g3zM 5EHi/Yp1g4k0JVXa8PQTtPlOaC2bzrtYgKAF9regZt1x+0M1TqxBomN5DlYa4QP5+8sH LJKg== X-Gm-Message-State: AC+VfDwMA6pfGf0GxWvrHBnALkiFZMCRwC+0wLzlVB++eB5kVgnL8FJY +hlV69h1KxdVN2V2EXLo8g7Kf9NTjCE= X-Google-Smtp-Source: ACHHUZ6d7c/UzOW1x/tzWGka5NYsAmxedIkcxML0OS6sxZnxq/0HwdNZLmVJqXf4dsP8FvGKrEVR/g== X-Received: by 2002:a5d:4403:0:b0:307:8800:bbdb with SMTP id z3-20020a5d4403000000b003078800bbdbmr21509154wrq.58.1684152797866; Mon, 15 May 2023 05:13:17 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id e7-20020adfe387000000b003064088a94fsm32075201wrm.16.2023.05.15.05.13.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 15 May 2023 05:13:17 -0700 (PDT) Message-Id: <94380984533e6677f48a71dc0ecdc5345ec89a17.1684152793.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Mon, 15 May 2023 12:13:12 +0000 Subject: [PATCH v3 5/6] ls-remote doc: explain what each example does Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Eric Sunshine , Sean Allred , Sean Allred , Sean Allred Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Sean Allred From: Sean Allred While it's good to have several examples to solidify the output pattern and generally demonstrate how to use the command, most other EXAMPLES sections (e.g., git-show-branch.txt, git-remote.txt) additionally describe the problem/situation to which the example is applicable. Follow this example in the ls-remote documentation. Signed-off-by: Sean Allred --- Documentation/git-ls-remote.txt | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt index aabc1a7b90b..c0b2facef48 100644 --- a/Documentation/git-ls-remote.txt +++ b/Documentation/git-ls-remote.txt @@ -99,13 +99,18 @@ OPTIONS EXAMPLES -------- +* List all references matching given patterns: ++ ---- $ git ls-remote http://www.kernel.org/pub/scm/git/git.git master seen rc 5fe978a5381f1fbad26a80e682ddd2a401966740 refs/heads/master c781a84b5204fb294c9ccc79f8b3baceeb32c061 refs/heads/seen +---- -$ git remote add korg http://www.kernel.org/pub/scm/git/git.git -$ git ls-remote --tags korg v\* +* List only tags matching a given wildcard pattern: ++ +---- +$ git ls-remote --tags http://www.kernel.org/pub/scm/git/git.git v\* 485a869c64a68cc5795dd99689797c5900f4716d refs/tags/v2.39.2 cbf04937d5b9fcf0a76c28f69e6294e9e3ecd7e6 refs/tags/v2.39.2^{} d4ca2e3147b409459955613c152220f4db848ee1 refs/tags/v2.40.0 From patchwork Mon May 15 12:13:13 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Allred X-Patchwork-Id: 13241315 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0D794C77B7D for ; Mon, 15 May 2023 12:14:01 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S241606AbjEOMN7 (ORCPT ); Mon, 15 May 2023 08:13:59 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42390 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S241518AbjEOMNm (ORCPT ); Mon, 15 May 2023 08:13:42 -0400 Received: from mail-wm1-x32e.google.com (mail-wm1-x32e.google.com [IPv6:2a00:1450:4864:20::32e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2054BE7B for ; Mon, 15 May 2023 05:13:20 -0700 (PDT) Received: by mail-wm1-x32e.google.com with SMTP id 5b1f17b1804b1-3f41d087b3bso96733795e9.0 for ; Mon, 15 May 2023 05:13:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1684152798; x=1686744798; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=i66nhZjaFs3AutU0Y8gQx7xe6TXqeAneOZQeAU4NaLg=; b=pxH4IATVIzesB2GbB6DHUSKU5osRNA42bnYsKEqp9fGDmXkeYw/ezZhqvxKkuBEaC4 wF2OsJQk6qz++K0MjG97LSBrgoOkif9bmadGVlXCPqyIrf/yW6Un3sjhD0ysRuJZ2uW0 2EC7KU4U714/2/+7Cv1xyIItMm+0am091j3J9pQD9Ov5rkhEEK2iGgayY/pBK14bM/b4 DhAcyIQ6wBeLH/OJpeKbPbAySvYvObAZnc5nEHJ3C16P/NKnaULo945ZRMhdR+PjGsdR 58oMhOTueJCQ8r2Bnr/vSvQzDR6fqPDU0banmiisW2Fh9nzdX0EfAEsrU0DYj+8ZPpxp /kCw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684152798; x=1686744798; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=i66nhZjaFs3AutU0Y8gQx7xe6TXqeAneOZQeAU4NaLg=; b=HGj75CZk3Sw0pY0lvZ1p/I/k0vm6B5Lmn/OtM70BB80UEu2SBuAZNiQ/oVTKFzDAY9 2h2pzwwFOHyUkSUuQCCGmUT+IvkBlk9gW8YAWtjCXsHWyA8Q4ME26bsSGn49cZslsPYb gBLX9qpW1Rxt+AKax9/dys/E5ahByZfSxZ0kohM3nGmodPRShttz427bvUqej4dCzNFH Z1qQfTIxOtFqu9UuAnUipa74HFy4fGC2G90Ds9qiIHrbGfPWqEF7Od3zhnscf8+8Zbd+ pVKjxw2NQVEDFPflW7OMKT0JFxK23J7nbL/gBIW5HsxSgniodnmgkcTYOSzHXy0aXbbn wf9g== X-Gm-Message-State: AC+VfDyPBehlzPiZkzWnOOyNU+SCXQpdLRapDOVLbErQwcTeWT5jqkwl WPW+isycl2oGTUY3tOQU/9T+NegE1hk= X-Google-Smtp-Source: ACHHUZ444reKwa5JQEoFYQaZkFaZTnR1MKfTGG2pT35irKXWGaR2zBX6xtqi7QX2EnxPvUj+h8qDyg== X-Received: by 2002:a05:600c:2108:b0:3f4:22ff:812 with SMTP id u8-20020a05600c210800b003f422ff0812mr19426298wml.26.1684152798358; Mon, 15 May 2023 05:13:18 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id k25-20020a05600c0b5900b003f4272c2d10sm22071059wmr.1.2023.05.15.05.13.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 15 May 2023 05:13:18 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Mon, 15 May 2023 12:13:13 +0000 Subject: [PATCH v3 6/6] ls-remote doc: document the output format Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Eric Sunshine , Sean Allred , Sean Allred , Sean Allred Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Sean Allred From: Sean Allred While well-established, the output format of ls-remote was not actually documented. This patch adds an OUTPUT section to the documentation following the format of git-show-ref.txt (which has similar semantics). Add a basic example immediately after this to solidify the 'normal' output format. Signed-off-by: Sean Allred --- Documentation/git-ls-remote.txt | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt index c0b2facef48..15313f2b10d 100644 --- a/Documentation/git-ls-remote.txt +++ b/Documentation/git-ls-remote.txt @@ -96,9 +96,33 @@ OPTIONS separator (so `bar` matches `refs/heads/bar` but not `refs/heads/foobar`). +OUTPUT +------ + +The output is in the format: + +------------ + TAB LF +------------ + +When `` is a tag, it may be followed by `^{}` to show its peeled +representation. + EXAMPLES -------- +* List all references (including symbolics and pseudorefs), peeling + tags: ++ +---- +$ git ls-remote +27d43aaaf50ef0ae014b88bba294f93658016a2e HEAD +950264636c68591989456e3ba0a5442f93152c1a refs/heads/main +d9ab777d41f92a8c1684c91cfb02053d7dd1046b refs/heads/next +d4ca2e3147b409459955613c152220f4db848ee1 refs/tags/v2.40.0 +73876f4861cd3d187a4682290ab75c9dccadbc56 refs/tags/v2.40.0^{} +---- + * List all references matching given patterns: + ----