From patchwork Wed Mar 3 09:21:55 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Denton Liu X-Patchwork-Id: 12114821 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.8 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,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 32321C43381 for ; Thu, 4 Mar 2021 00:22:56 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 0600564E59 for ; Thu, 4 Mar 2021 00:22:55 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238564AbhCDAWs (ORCPT ); Wed, 3 Mar 2021 19:22:48 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:37800 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1843055AbhCCKY7 (ORCPT ); Wed, 3 Mar 2021 05:24:59 -0500 Received: from mail-pj1-x1035.google.com (mail-pj1-x1035.google.com [IPv6:2607:f8b0:4864:20::1035]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1C71EC0698DB for ; Wed, 3 Mar 2021 01:22:11 -0800 (PST) Received: by mail-pj1-x1035.google.com with SMTP id e9so3963661pjj.0 for ; Wed, 03 Mar 2021 01:22:11 -0800 (PST) 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=HfpAL1/8NNR81JAF5gtWY9dktgJMgCLxLCtemiMSSk8=; b=hvyQHR25WAF+fRRFCqr45vATfAJ9GiLWHtAmPWstRnL2pZdReC1MdEi9ZSHuWFMg8h dd37lABGnxBH6zCkIhH07rXZySdAKDfLqLJw3BO/Yz38PcipLxsNXCKZDkPyEnl9SoFU HuglzpLBtdS3QKfWjJWthlZ1vBM/i47v3yGdi/LkSGOgUycNqaw+2TCWcxXfUwqTAfkd eC96uJAB5D67+d/XArjsjQVsm0mMIyjHHwJV+IFtZ2qCez8caJ7BxI8aT139a6sNl33E 1+H6vUl7a9KS4g232BuqCajMm2EntaygHbDfOjrdBShF/cOA2kdsCvcNnn94K42XNu/U Pp8w== 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=HfpAL1/8NNR81JAF5gtWY9dktgJMgCLxLCtemiMSSk8=; b=czCwNy5226xoI0CN6Biw0iXoPunbsgeYhhd7GbMpg1Wc6qv0VuU2rtnzyXmx+ChUb9 fUBHlzcsKdPkU7KKaXKL+6z4kkt6knqI+82su2xgsysaE2/mKJaThK2PZ9KLD0exj47S XC67BWv45DlJz4chMaAlKt5HnqWbPKFBjEUozu7uXzzBy7gnteVg1FdMBIg1mElb8Bue fUiazM/ucJxjSMAEFinWBnZ4oEH0XJv61ffOgBX04yRq2rv6zKAnqXoPKH5nnlCDP1De p5NHfRKRyDu0XjY9rBL0kpBkJT2tLQo5SdbqryU9jbs8S3sNP/a0OF8ieoDK8ann6Fd5 eAYQ== X-Gm-Message-State: AOAM531lvQBnEILj/UWkRHoqSLxvAUsirYDhVxgcsx5EUUamRXeMbdjm wD5t5T8pn4znimbBD7/bvZPatIoY1+o= X-Google-Smtp-Source: ABdhPJy+RiOmN0761Vmn4bfmztd9PsIRA86fGFxFffhzIgXybppj7HtcywRr5PsSRmNBnGyK9rtahw== X-Received: by 2002:a17:90a:d90a:: with SMTP id c10mr5870191pjv.13.1614763330079; Wed, 03 Mar 2021 01:22:10 -0800 (PST) Received: from archbookpro.localdomain ([172.92.165.181]) by smtp.gmail.com with ESMTPSA id a11sm13986861pfk.109.2021.03.03.01.22.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 03 Mar 2021 01:22:09 -0800 (PST) From: Denton Liu To: Git Mailing List Cc: Eric Sunshine , Junio C Hamano Subject: [PATCH v2 1/2] git-cat-file.txt: monospace args, placeholders and filenames Date: Wed, 3 Mar 2021 01:21:55 -0800 Message-Id: <6d044cf540e81ff5218e730172ab5044f7b3a139.1614763281.git.liu.denton@gmail.com> X-Mailer: git-send-email 2.30.1.823.g0a3b79fd18 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org In modern documentation, args, placeholders and filenames are monospaced. Apply monospace formatting to these objects. Signed-off-by: Denton Liu --- Documentation/git-cat-file.txt | 56 +++++++++++++++++----------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt index 8e192d87db..a1c37a9e81 100644 --- a/Documentation/git-cat-file.txt +++ b/Documentation/git-cat-file.txt @@ -35,42 +35,42 @@ OPTIONS -t:: Instead of the content, show the object type identified by - . + ``. -s:: Instead of the content, show the object size identified by - . + ``. -e:: - Exit with zero status if exists and is a valid - object. If is of an invalid format exit with non-zero and + Exit with zero status if `` exists and is a valid + object. If `` is of an invalid format exit with non-zero and emits an error on stderr. -p:: - Pretty-print the contents of based on its type. + Pretty-print the contents of `` based on its type. :: - Typically this matches the real type of but asking + Typically this matches the real type of `` but asking for a type that can trivially be dereferenced from the given - is also permitted. An example is to ask for a - "tree" with being a commit object that contains it, - or to ask for a "blob" with being a tag object that + `` is also permitted. An example is to ask for a + "tree" with `` being a commit object that contains it, + or to ask for a "blob" with `` being a tag object that points at it. --textconv:: Show the content as transformed by a textconv filter. In this case, - has to be of the form :, or : in + `` has to be of the form `:`, or `:` in order to apply the filter to the content recorded in the index at - . + ``. --filters:: Show the content as converted by the filters configured in - the current working tree for the given (i.e. smudge filters, - end-of-line conversion, etc). In this case, has to be of - the form :, or :. + the current working tree for the given `` (i.e. smudge filters, + end-of-line conversion, etc). In this case, `` has to be of + the form `:`, or `:`. --path=:: - For use with --textconv or --filters, to allow specifying an object + For use with `--textconv` or `--filters`, to allow specifying an object name and a path separately, e.g. when it is difficult to figure out the revision from which the blob came. @@ -115,15 +115,15 @@ OPTIONS repository. --allow-unknown-type:: - Allow -s or -t to query broken/corrupt objects of unknown type. + Allow `-s` or `-t` to query broken/corrupt objects of unknown type. --follow-symlinks:: - With --batch or --batch-check, follow symlinks inside the + With `--batch` or `--batch-check`, follow symlinks inside the repository when requesting objects with extended SHA-1 expressions of the form tree-ish:path-in-tree. Instead of providing output about the link itself, provide output about the linked-to object. If a symlink points outside the - tree-ish (e.g. a link to /foo or a root-level link to ../foo), + tree-ish (e.g. a link to `/foo` or a root-level link to `../foo`), the portion of the link which is outside the tree will be printed. + @@ -175,15 +175,15 @@ respectively print: OUTPUT ------ -If `-t` is specified, one of the . +If `-t` is specified, one of the ``. -If `-s` is specified, the size of the in bytes. +If `-s` is specified, the size of the `` in bytes. -If `-e` is specified, no output, unless the is malformed. +If `-e` is specified, no output, unless the `` is malformed. -If `-p` is specified, the contents of are pretty-printed. +If `-p` is specified, the contents of `` are pretty-printed. -If is specified, the raw (though uncompressed) contents of the +If `` is specified, the raw (though uncompressed) contents of the `` will be returned. BATCH OUTPUT @@ -258,7 +258,7 @@ If a name is specified that might refer to more than one object (an ambiguous sh SP ambiguous LF ------------ -If --follow-symlinks is used, and a symlink in the repository points +If `--follow-symlinks` is used, and a symlink in the repository points outside the repository, then `cat-file` will ignore any custom format and print: @@ -267,11 +267,11 @@ symlink SP LF LF ------------ -The symlink will either be absolute (beginning with a /), or relative -to the tree root. For instance, if dir/link points to ../../foo, then - will be ../foo. is the size of the symlink in bytes. +The symlink will either be absolute (beginning with a `/`), or relative +to the tree root. For instance, if dir/link points to `../../foo`, then +`` will be `../foo`. `` is the size of the symlink in bytes. -If --follow-symlinks is used, the following error messages will be +If `--follow-symlinks` is used, the following error messages will be displayed: ------------ From patchwork Wed Mar 3 09:21:56 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Denton Liu X-Patchwork-Id: 12114813 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.8 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,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 8FAA3C433E0 for ; Thu, 4 Mar 2021 00:22:41 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 57B286146D for ; Thu, 4 Mar 2021 00:22:41 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1343840AbhCDAWj (ORCPT ); Wed, 3 Mar 2021 19:22:39 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:37980 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1842945AbhCCKWw (ORCPT ); Wed, 3 Mar 2021 05:22:52 -0500 Received: from mail-pj1-x102a.google.com (mail-pj1-x102a.google.com [IPv6:2607:f8b0:4864:20::102a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0E541C0698DC for ; Wed, 3 Mar 2021 01:22:12 -0800 (PST) Received: by mail-pj1-x102a.google.com with SMTP id e9so3773903pjs.2 for ; Wed, 03 Mar 2021 01:22:12 -0800 (PST) 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=sxby1aKrpgP43MfKf3jSXJmiVri5Qm66HsIJa8Gj7L0=; b=dJ9z/DzAlB+JErJqLGM7sMbvPPj7tsLOgNEiqz0fKMsUW9KIdVW9fyNxZWzEMAlwD/ cu2vcMfOrXPdEPjNFij0ZVLECITfWJ2t8pMZduPdO2MPNVjQ8lj9v4fWtwGwQbdnigii SUKdGirtHHMobRTWJdtePAtPkj799Q9dlHeTat3Qzu65cOiNLqQ6sUUz0St8oCnmM42S K5HCzAi66GvsrWsqMM5bArMgLTzJH2qcZoVGSsBlzSyQslcyhyOfVgsGn+avr/A8/BTw k/Pa5YYMHdp0AYlLqYJObYg5sE5ViwcVtCvVKw+lwPB4o61tBQAyQ5baxcL2iKPHuG1l SHGQ== 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=sxby1aKrpgP43MfKf3jSXJmiVri5Qm66HsIJa8Gj7L0=; b=t3KwoWBCuF4WHTRnEakG1QSchc3yBSBylKEa6ZJidKYc6kqs+4b0+t+bb0X/QN0T1r G1EeGvDd2rhnlPl0Pujh6V7FWb+WvKFYhjCQuQtV3Wz65YLGrlFpGvEjEGl7RB+9067m 7MGUY07Qdhucs1PzNfgx/ry3uFiSLslvyZfazzCBIjPTrCdu7D8knpavbFveqLjLyCNQ EOm3PRhBiFUxxZo0ucV63gfshzRA7yifaZ0qTWV3zMAEjXHlk9MP8lj7OB21V+aWZAYi 5unW6Zwf4I8SAmWXrF/+X7uhzsX+oTCF9sEi7+mA4+9RK2Xr3VWo7OhhZDUefprMPEVH kjDg== X-Gm-Message-State: AOAM531ngTmdu0IozeOsS3EH3ihJDv9aRYIbq+3+LCMGrKoyl5b9SII9 vogXDvRi+5iJf8km77h9C3XpI2+wSNI= X-Google-Smtp-Source: ABdhPJxReE1gdtegDa5r4+7+yUgzI8z9nghNC2SpBWEvFFUmU3QtaOYfdBz1LbVaOa/0ahlf5YT5rQ== X-Received: by 2002:a17:90a:9f4a:: with SMTP id q10mr8926703pjv.129.1614763331381; Wed, 03 Mar 2021 01:22:11 -0800 (PST) Received: from archbookpro.localdomain ([172.92.165.181]) by smtp.gmail.com with ESMTPSA id a11sm13986861pfk.109.2021.03.03.01.22.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 03 Mar 2021 01:22:11 -0800 (PST) From: Denton Liu To: Git Mailing List Cc: Eric Sunshine , Junio C Hamano Subject: [PATCH v2 2/2] git-cat-file.txt: remove references to "sha1" Date: Wed, 3 Mar 2021 01:21:56 -0800 Message-Id: <1b57fdad9767a3b63c359e1663e5a045b4964320.1614763281.git.liu.denton@gmail.com> X-Mailer: git-send-email 2.30.1.823.g0a3b79fd18 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org As part of the hash-transition, git can operate on more than just SHA-1 repositories. Replace "sha1"-specific documentation with hash-agnostic terminology. Signed-off-by: Denton Liu --- Documentation/git-cat-file.txt | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt index a1c37a9e81..4eb0421b3f 100644 --- a/Documentation/git-cat-file.txt +++ b/Documentation/git-cat-file.txt @@ -200,7 +200,7 @@ object, with placeholders of the form `%(atom)` expanded, followed by a newline. The available atoms are: `objectname`:: - The 40-hex object name of the object. + The full hex representation of the object name. `objecttype`:: The type of the object (the same as `cat-file -t` reports). @@ -215,8 +215,9 @@ newline. The available atoms are: `deltabase`:: If the object is stored as a delta on-disk, this expands to the - 40-hex sha1 of the delta base object. Otherwise, expands to the - null sha1 (40 zeroes). See `CAVEATS` below. + full hex representation of the delta base object name. + Otherwise, expands to the null OID (all zeroes). See `CAVEATS` + below. `rest`:: If this atom is used in the output string, input lines are split @@ -235,14 +236,14 @@ newline. For example, `--batch` without a custom format would produce: ------------ - SP SP LF + SP SP LF LF ------------ Whereas `--batch-check='%(objectname) %(objecttype)'` would produce: ------------ - SP LF + SP LF ------------ If a name is specified on stdin that cannot be resolved to an object in