From patchwork Fri May 19 04:17:49 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Allred X-Patchwork-Id: 13247667 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 F17CDC77B75 for ; Fri, 19 May 2023 04:18:15 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229675AbjESESO (ORCPT ); Fri, 19 May 2023 00:18:14 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46518 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230074AbjESESG (ORCPT ); Fri, 19 May 2023 00:18:06 -0400 Received: from mail-wm1-x336.google.com (mail-wm1-x336.google.com [IPv6:2a00:1450:4864:20::336]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4339610C6 for ; Thu, 18 May 2023 21:17:58 -0700 (PDT) Received: by mail-wm1-x336.google.com with SMTP id 5b1f17b1804b1-3f50020e0f8so2203775e9.0 for ; Thu, 18 May 2023 21:17:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1684469876; x=1687061876; 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=ZOmXZBVYK0/JUm+9xyrublcR+LkoUPIi7w9y1Zqps/U=; b=YKv9u1P5DQETo7K3n7TBvHVJ0GCa1IbWHs8Q8SmczB8MuUCYSIdEdIb1krMHqAHnsI vtuANiAUMS3K9XkqOnlUrLK6TQygqvL9j5gNyrLwNa6uhyGU4XdwBXv+RRMBLWDnNon7 Gt3WhQtYPjiF83A7XIdsspO7ONmWO9cl8JC70ywUlDLc8mg/Mv+se0Kjzt01Tfnjct85 UqjgeZle+U8EQSmDee49pAJVHQOJtDRbo//8hG/o3wDINOIwhA5fSvUH6oVrDnnj1kXT iuq8dmrpRygkYzgZ2IqpWXCaKNKSIytjjH4VDfgkOR4JRDh2hosmjhLEtKdg+RlfzwKN 4c6w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684469876; x=1687061876; 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=ZOmXZBVYK0/JUm+9xyrublcR+LkoUPIi7w9y1Zqps/U=; b=Ty79ZFsiHWHyuIdJGUzv5ZryXp3jiyM3Blg+Y8pan3uPahPqsl610OzhQVws0G7xWa v500PUPhb2lZXoYz1Ivk+I76V6wCov1wUedYW/axRndQmX1/IKQ/4muyZD3ZPwtsgay0 97+R3TEKQe7S2FFXuMz2QgBA8Rj+mSzoMQHOTkU3hYnnHS/qL0NoDyk+gJNZ1slXqTjX 4rxWSg7JWZJw0+8hnITr19o1RURVjiizdKzXi62kJBdaAiP6bkRWdA6qaq4LMiXjAywp +xXeErQY32SdjDNXjNj4ws2Xhr/8v5cmWbyDMaFJKdO03/Ye8+zCJJMv3Q/u0SMEyuwP gbHw== X-Gm-Message-State: AC+VfDwTXwsOiegBuSjC+3gLeENJDayIRrVqF2bA8ErDbuWYwlxt2lzy eCntj2x1OFmRw95J2pZUOMR1UdqX/gg= X-Google-Smtp-Source: ACHHUZ4LuUqVmfQFOd+mAW4sM5dFTkTCBvKwkaAS7LbOMmru0LB/14eNangyO1VazjtGUD7C/MKR1w== X-Received: by 2002:a7b:c448:0:b0:3f4:2aeb:30d with SMTP id l8-20020a7bc448000000b003f42aeb030dmr292750wmi.4.1684469876432; Thu, 18 May 2023 21:17:56 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id w19-20020a1cf613000000b003f1958eeadcsm1023781wmc.17.2023.05.18.21.17.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 18 May 2023 21:17:56 -0700 (PDT) Message-Id: <49382e81e02c4da2460eb35978044b6ed2e3049a.1684469874.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Fri, 19 May 2023 04:17:49 +0000 Subject: [PATCH v4 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. - Use 'OID' (for 'object ID') instead of 'SHA-1' as we support different hashing algorithms these days. 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..44c7387d78f 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 Fri May 19 04:17:50 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: 13247668 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 09CACC77B7F for ; Fri, 19 May 2023 04:18:18 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230274AbjESESQ (ORCPT ); Fri, 19 May 2023 00:18:16 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46522 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230077AbjESESH (ORCPT ); Fri, 19 May 2023 00:18:07 -0400 Received: from mail-wm1-x336.google.com (mail-wm1-x336.google.com [IPv6:2a00:1450:4864:20::336]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E681510DF for ; Thu, 18 May 2023 21:17:58 -0700 (PDT) Received: by mail-wm1-x336.google.com with SMTP id 5b1f17b1804b1-3f41d087b3bso27741275e9.0 for ; Thu, 18 May 2023 21:17:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1684469877; x=1687061877; 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=fe4WjiPPnt8J0qNmuElOfzoLFLwRnaVZXM2j7NoQaB1dXNlQHHKxDdtZDJ+DvDxAYb 96eyykCFLagd/lHNz4rudULlbW/DpRqPsgYx8ZV4YTE8ZJ4UTVFTQNXSB2KqQoKdD9uz l/7m/a/3SttK8+JVScF5AhDQlV7rwsJgT6eMzIyg+a/3ZxwWcjk13PFX3NaERjODCsp4 xiHkGLv1rnnNgxN5r+rWiBDfaApCTWP20a3wThdxDRHT6EuCVwYMQmTXKcD/084Bk95g 8OdSlu4apljxKln4pihfEPt2wVlHbrQcKiX6Hlooo20kbA3V3MAZuJcQ8GhgbVtH9ZTD Q03A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684469877; x=1687061877; 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=EJBpY2qUIHRVD7MhQp+b3W/YYBvquHgGEdvnXm++sWE21U/AVl7f8qa5QAKg1d0zgO 3zDPiHNaEWi1/qTIQJ+uI4GVUKnUg6mmg/t+Rl3S/Kn6uU/d08fDj5vXg1cP55u87D7s zrwpUBun+MTRfpiAaTS4CrwNk2NX/8RyPAy1cMdyk5LF+fgnYvb9H57vwZVL0ULqeVJL /QzwTSLpUFErDMDrFHyvDpDKrRk5wO/LmGq8xisL3S2c8OBCiVjDUFrNsVg3pwN/vPmR ba1uTyXiWSR0yt9oGdxJVKHCEli4r+Lp1BPTMCGOmrFgzz8/0VJ/E0hohPRGq04Wb4+a iZZg== X-Gm-Message-State: AC+VfDwLKzrOEdRrGZt9nNAZP312pdzeFVfD/Iw7CvsHVgcUN0Q9ncX2 rhwPKYK3gRffiR30R/8O3mF+kUKRM1s= X-Google-Smtp-Source: ACHHUZ7R/cyEh13g6a/SoynMinGZmc+6ha2Ay13EN6SBybtg7hDRkOs7VKqLyjPXp6VsK21+QXn8eg== X-Received: by 2002:adf:e781:0:b0:309:4642:8793 with SMTP id n1-20020adfe781000000b0030946428793mr427216wrm.15.1684469877204; Thu, 18 May 2023 21:17:57 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id v25-20020a05600c215900b003f423508c6bsm971354wml.44.2023.05.18.21.17.56 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 18 May 2023 21:17:56 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Fri, 19 May 2023 04:17:50 +0000 Subject: [PATCH v4 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 Fri May 19 04:17:51 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Allred X-Patchwork-Id: 13247669 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 463AEC77B7F for ; Fri, 19 May 2023 04:18:26 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229736AbjESESX (ORCPT ); Fri, 19 May 2023 00:18:23 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46532 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230044AbjESESH (ORCPT ); Fri, 19 May 2023 00:18:07 -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 E224010F0 for ; Thu, 18 May 2023 21:17:59 -0700 (PDT) Received: by mail-wm1-x334.google.com with SMTP id 5b1f17b1804b1-3f42c865535so27627615e9.1 for ; Thu, 18 May 2023 21:17:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1684469878; x=1687061878; 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=UWkkqokdTKjer5GWgcNenoHcbHAexf9/Adf3XDI+aY7Dq7zm4xlf2ch1/UUn0kcS16 hg2tPsyoy2cMYlS3iwJaDXM10hFz0iEG0kSBqPIAnwFr9Gvyc+Q6r8j+C648F9X/cZBv sJRjx2h2puvoqtA9oUMWX7oOIeI13e5IRHigEq74mkBsdkfG4QNgENyyb84IZP7VKV9E KXViwUe1Yxk2WxFn0E0D01NnWrp25uR+ZIYteolm36xbdcJx/sE/1WHBPtCSh9+c+jo1 YLEVBfxrYAUsGr2K8W5c3ZmGcXpeLiCMjUQdEHJdv+ZeszdiIMIk3J47lsK8zpGM/DKe zmtw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684469878; x=1687061878; 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=O7kLqlx/q1kELxPsQ5N4Owu+iu28h3fRmDNk6/CBgSo8VcmIhG2pv7Kj6RbHiMOwUt B563BtUKqsnQwWDu/Vjls8zzvcCVNQlpFB3c/j54p6CNs1p0J+nxBpSIPvWdzi9dR375 +OjOkkiLHfc84xgWpcgWH8YQLS2iWQCUOW8yGDMBrbutqRvvn97QaHRl25Fm1MQoOMge q+PP72wBe3SKopmO/bEb2RGEJxk+FCcsd9annqThmMHi83OLNIdSLxiIfotUQ51Xkthf SQU6btbAXoauSD3gYmLg5uaFA6D9v/oGOlzKIhxjhaGEwGxm1qtOeHu4wk9afUlkA+pu PsBg== X-Gm-Message-State: AC+VfDyzEu5Z6ru9HmZbhSOhhPglEv2zWyGN4VLgr2qvQTQoziHBuuam aR2CN3cObg2MZlwCte3iQHAPxtt6Kgw= X-Google-Smtp-Source: ACHHUZ7/ZHlgdwaHsKX3N9J6JbPvQPwcrODki6TT531NXwArAvJ4xEeob4taSw/O9r6oZBM4s44t/g== X-Received: by 2002:adf:fc85:0:b0:309:4165:f733 with SMTP id g5-20020adffc85000000b003094165f733mr549481wrr.17.1684469877935; Thu, 18 May 2023 21:17:57 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id l9-20020a5d5269000000b002fefe2edb72sm3923266wrc.17.2023.05.18.21.17.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 18 May 2023 21:17:57 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Fri, 19 May 2023 04:17:51 +0000 Subject: [PATCH v4 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 Fri May 19 04:17:52 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Allred X-Patchwork-Id: 13247670 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 BEF67C7EE2A for ; Fri, 19 May 2023 04:18:27 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230369AbjESES0 (ORCPT ); Fri, 19 May 2023 00:18:26 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46536 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230109AbjESESH (ORCPT ); Fri, 19 May 2023 00:18:07 -0400 Received: from mail-wr1-x432.google.com (mail-wr1-x432.google.com [IPv6:2a00:1450:4864:20::432]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B06AA10F5 for ; Thu, 18 May 2023 21:18:00 -0700 (PDT) Received: by mail-wr1-x432.google.com with SMTP id ffacd0b85a97d-30796c0cbcaso2786185f8f.1 for ; Thu, 18 May 2023 21:18:00 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1684469878; x=1687061878; 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=NBFX6AbWB5oAyWb1bTpVZxP6fyqmHNt3ZtB3VLcVCDYsPkNuy9Pe17Zskxh+35Wjz1 80fTN6CC0503uzgYCuytgi6Thm/7RiGrfJ/CAiGxZb0GpqFLk1FPR7lZlDuwKVbu/XR/ RcB2eDTddQwflJba8tWxgdluqckxiSjjh64CsjsfroyXwWX/RXk8dk2u2zToHVKsQTwX o6yDNkKuauy99whb9KVVPU5KjotBKOVFfJon8/2WixmJi1uFsj8K79KSxSlhEDlrxNK6 hTxzBT0AK5bWij1U8KNPTj50yLYAT0QJUL5pLxl/evBG95RPUKegbU6SBHgTd92YrdWn Tzag== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684469878; x=1687061878; 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=ZpfQcT7JENen9yRSIi/raLHuQOL0HwLSbpbULwea4oZCwJzvs38EPoXr24Lfk/8qZd cs+fmngEzweMne7ophJeRTYcPGUBunLArZkSTvx240sX1bFmNMzEHkYuofMgIiRdGCe+ gm2tLtx9b65jwHYMYm4lXJ3ArpNUTj/ljqG18I25gOWHBkboYA1Dwl7VIYwPhP48Z9a4 EJMMBS8ZOCI0qyoCbDDi3xWD2O8x9iLmS7h5P+bOmdS/4ZYr8HrFkeMv5imbuBXPn7OV /sQFA1gbDpf8kbEKK1/utGEVlZSj1Ymh5mqAHJwtfOp0wk5EUKe1LEpWcuOD4V/mBedf jXQg== X-Gm-Message-State: AC+VfDxgJt1LonU1zh53jhu3Ol6ZXPirrIowknYay5CtfkELCVGH1ltL VZ1+5H7rrqfClBxLeh3Uyyh59UDNGcE= X-Google-Smtp-Source: ACHHUZ78cY3hchLrKN2ZfxacVNvUaXbbcl0D1sFMz4rdcWZMYXRDNeaZsPxirphLlQUXE1XeqEQqbA== X-Received: by 2002:adf:f8c4:0:b0:309:4358:5afd with SMTP id f4-20020adff8c4000000b0030943585afdmr434436wrq.54.1684469878528; Thu, 18 May 2023 21:17:58 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id j3-20020adfe503000000b003062675d4c9sm3971485wrm.39.2023.05.18.21.17.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 18 May 2023 21:17:58 -0700 (PDT) Message-Id: <68c35f605aea8577b05c1f7b5917e1bcfbd16df1.1684469874.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Fri, 19 May 2023 04:17:52 +0000 Subject: [PATCH v4 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 Fri May 19 04:17:53 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Allred X-Patchwork-Id: 13247671 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 E3E8DC77B7F for ; Fri, 19 May 2023 04:18:30 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230387AbjESES3 (ORCPT ); Fri, 19 May 2023 00:18:29 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46550 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230186AbjESESI (ORCPT ); Fri, 19 May 2023 00:18:08 -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 169B81702 for ; Thu, 18 May 2023 21:18:01 -0700 (PDT) Received: by mail-wm1-x334.google.com with SMTP id 5b1f17b1804b1-3f423521b10so18080025e9.0 for ; Thu, 18 May 2023 21:18:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1684469879; x=1687061879; 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=kAN1DVjA0DUW3jkq81IrQZKVLEmNsPHqDf7Y647MbF7b4KNjxUTawKwA4hVKz+01Og k2yaMbMi8MfTpzIs85v2ATVgwWNmkB3zKIQ5jtrEdvXFoLOQZlviJtzTxJlJQ55jKpNi DfMODc7N0Gp+wCvVK9a+TxuArGd62nnv71d2cZkPCe5uH/08sde8wmxDExseAO6UddAO 5/5Qn/JVGrt+Aswh45iTmW78KX5U3Zixml3Nv2+DgSZ2yJUcPczfl2BfyZGExpWiFFQ7 dLqCtUHiuTtHtU+iD4MV0aCYPtzMfFjC96jOt1LMzDcIPypsoTLP7mdGAcC40PQkrBvm ykfA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684469879; x=1687061879; 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=G4CmIkwd7rFf6x7rZrbrOVBMEORC8X5z8cGRgFn66EbtTkBtvgMg5O/d07jyiysV2+ ir/kZW4dTafkSzt9UOkoy7Czb3Y1/59okiaTIWrEsZa36K43MoDXBrwqqSlSLVh90Yn8 212MbbT39gHhng0h/tkl1hIfaVfGS1V7CLdYMkGBkwSqnIHKIaSKuWFzx9iGkRuO6bS0 vtotuusTrMmLAeTh1w0TAu6/G89e6/m7NC+clModQqBzdgngy7U1WXL1NjM2Z19rg/3Q oDtgmOCZsL9BVJwi6ZvzoDRO8sa+tyZFYMFtIL6EKJSNE18OqdXXUnXCQuX0KJufthOb KNNw== X-Gm-Message-State: AC+VfDwysvPcVOQT0VHOFHT62GK0yZuy5oLElB7bdTgHBRUHzjLVvhxX 0t2czV5VA9oQ5AJVWPaFzWw7ngXo0SQ= X-Google-Smtp-Source: ACHHUZ6mGPOYYaPgk/n+qnCujf7NfJTlrwypoUuOAwzvxmAToPEOGY0bOyTTUMkyLTHuOTBkVLq5QA== X-Received: by 2002:a7b:cb96:0:b0:3f4:1a97:ab09 with SMTP id m22-20020a7bcb96000000b003f41a97ab09mr238710wmi.25.1684469879358; Thu, 18 May 2023 21:17:59 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id a7-20020a05600c224700b003f4e8530696sm961782wmm.46.2023.05.18.21.17.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 18 May 2023 21:17:58 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Fri, 19 May 2023 04:17:53 +0000 Subject: [PATCH v4 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 Fri May 19 04:17:54 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Allred X-Patchwork-Id: 13247672 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 D88ECC77B7F for ; Fri, 19 May 2023 04:18:43 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230435AbjESESm (ORCPT ); Fri, 19 May 2023 00:18:42 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46524 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229452AbjESESM (ORCPT ); Fri, 19 May 2023 00:18:12 -0400 Received: from mail-wm1-x332.google.com (mail-wm1-x332.google.com [IPv6:2a00:1450:4864:20::332]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 072F81711 for ; Thu, 18 May 2023 21:18:02 -0700 (PDT) Received: by mail-wm1-x332.google.com with SMTP id 5b1f17b1804b1-3f475366514so18846025e9.2 for ; Thu, 18 May 2023 21:18:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1684469880; x=1687061880; 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=wUxDjmR2HiA0zivtxzM6KGVGVfv1DJVlGyegqAInWbg=; b=S/5vkgLwCx8dlNu2qtMSG46yxanQ5zAddCHVfZKkQ85sKDW5AQefxRir+0sgtU5opL cVL34Zg9N0s88c8/Bjgnv8CNicWtG7rQN75vaBejAbyEfwCF78eYDO9GcefBSPIo1E36 kHri9YN7XVWKTnyHiRmHaN95OrJunxqu5r9EaIIGW8KL7n8a4ZivBezHDyCX8YgbEcwo pIFSnYw/B+hOmF9mnwyyP8VlgrJDPuOZq9/irkn6jxIh/GS3XPjc0Md5Kfu4vZWsoIbw c3NtcIWaGxpf5lQixy6QQSBk9SAfeovWzznlR/lRGy6ga4yL465PvLCwU7nHvLLP2F8I Cokw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684469880; x=1687061880; 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=wUxDjmR2HiA0zivtxzM6KGVGVfv1DJVlGyegqAInWbg=; b=JcNa062BKavE7NBJZz4f0x1YLw0nmbjj59MWa/Ir/JaGPAu4njL2aftcY/XuHr+x03 e7cAZlJUxTekulrCx+eEh6dWEYxtfpQs9GpXSGI/wuTM0L/fvDnWQXqkZhuZagm7AMBk zlW1SJoVKdoscJph2KJk6Bi9OpiwvnIVKUpnBfhaJ1BmYqKVeMeVemnNF0ruQy+l9Ggx zx8HaiWx2BS27GmlcZimT91nBzGdmeJdE6KEuhd0b+5vO2W46BsuScVT4EOW1LbzYtg+ dcFd0ueyLzbMh/2pLP5aygUG+9HCsLmkTH05NIJFXO16eAcv9PJiKaUnrAJcYKKGDva9 1b+A== X-Gm-Message-State: AC+VfDzwKw7enxQ+NcVtNr21jaYiLwxztR11tjH65C6wX/YR67k5Us8e 0FyaZAMvjTrueHTsx62u2WHPsxtBAK0= X-Google-Smtp-Source: ACHHUZ7mcuO20XI/UO7n+jxyMubKbjlk9KZxfhBpU9G46iTWCHcTWWjvkOyiZ6fwrSRU+LHB/IHpwg== X-Received: by 2002:a1c:f20b:0:b0:3f4:16bc:bd1b with SMTP id s11-20020a1cf20b000000b003f416bcbd1bmr188581wmc.39.1684469880206; Thu, 18 May 2023 21:18:00 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id n13-20020a7bc5cd000000b003f423f5b659sm1033559wmk.10.2023.05.18.21.17.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 18 May 2023 21:17:59 -0700 (PDT) Message-Id: <115dba15ce03bb2aadac43810738bd762d837b41.1684469874.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Fri, 19 May 2023 04:17:54 +0000 Subject: [PATCH v4 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 | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt index c0b2facef48..1c4f696ab57 100644 --- a/Documentation/git-ls-remote.txt +++ b/Documentation/git-ls-remote.txt @@ -96,9 +96,35 @@ OPTIONS separator (so `bar` matches `refs/heads/bar` but not `refs/heads/foobar`). +OUTPUT +------ + +The output is in the format: + +------------ + TAB LF +------------ + +When showing an annotated tag, unless `--refs` is given, two such +lines are shown: one with the refname for the tag itself as ``, +and another with `` followed by `^{}`. The `` on the latter +line shows the name of the object the tag points at. + 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: + ----