From patchwork Wed Aug 5 01:19:05 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: =?utf-8?q?Jean-No=C3=ABl_Avila_via_GitGitGadget?= X-Patchwork-Id: 11701121 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 07D41913 for ; Wed, 5 Aug 2020 01:19:18 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id F355C207FC for ; Wed, 5 Aug 2020 01:19:17 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="cNXUBltL" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727114AbgHEBTR (ORCPT ); Tue, 4 Aug 2020 21:19:17 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44232 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727055AbgHEBTN (ORCPT ); Tue, 4 Aug 2020 21:19:13 -0400 Received: from mail-wr1-x444.google.com (mail-wr1-x444.google.com [IPv6:2a00:1450:4864:20::444]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B6981C06174A for ; Tue, 4 Aug 2020 18:19:12 -0700 (PDT) Received: by mail-wr1-x444.google.com with SMTP id l2so28531645wrc.7 for ; Tue, 04 Aug 2020 18:19:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=4ym1IzoRp2NjrKCQfPSxjzCBmGas+7GV3dRMTATrHus=; b=cNXUBltLbXDjl123CaQcUQACDgxtfD//VuCMh3wKhUyag3RZ/uOUncWUjO/5qI2SFv qvWaX3A08TtJrmps7p/eF10IKpEVEkAgTKU1GhzGt4asF4XhA+70YgZAB7Dc++NBMG3e NJVTZVKq07k6HnBR0SJX8XoJKtRv/mO7+iK9UpE0QKhoxuOa/yRSeyaR3q+zMRvtoh/e 0289/baKm0NUtnj3ilgNpCm2NrylU1K3WDN0oXfK6hr4oC7fzH4sLH8XoXPLfEufeacx Vpq1TXF+5q6EgD1AxP+HTSO4JiIZQ0j1Ty58T97eArnKE/a2qulxEY52l5qjU7kK9PxQ IKpQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=4ym1IzoRp2NjrKCQfPSxjzCBmGas+7GV3dRMTATrHus=; b=X0Hgs2x8IPavYyek50l3/xm5sO3krLBRyoaLc/r3zlbDOG7j8XB3geR5ngYLcsCFHc O31MSIb557AbB4trukbezlIi6oe6BOiT/1kqwguTbgKYnGL+1XAmLD5tKxNTqfhf33Sm 93TgVs0DXzyFo7bIiF+KEgIiOUDCPMiOeL7xuXVvPhv96yKdCI7CcDAj/lwcg0p6VSaF cpIfbn1/f9pH5tGUZZJOoPnQacJ4+0ZMz7bDcdQeG+fwqOhsxSTr8+m8aiX6Af+JogPB ThtXcq7qUYNY+4DpBcti/AY7BUthMSOwLad7Fkb1UQRpvUlBhVzDo/qnWuEGfsoyNr5f MuMA== X-Gm-Message-State: AOAM533tyM1KK8hudfNrWHxri+NM/BV4QagqOK9n7POOcXVjejlk//6C impeva9WxQf1TjhWTljzyC2OR5eG X-Google-Smtp-Source: ABdhPJzXefeBF3Gxws2gFLVBaMBfxLCPLY9hHvzfM6prfAjPk203yeL/t2WhxbN6PC24sZ962yfj6g== X-Received: by 2002:adf:f289:: with SMTP id k9mr486583wro.203.1596590351232; Tue, 04 Aug 2020 18:19:11 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id p14sm596548wrx.90.2020.08.04.18.19.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 04 Aug 2020 18:19:10 -0700 (PDT) Message-Id: In-Reply-To: References: From: "Philippe Blain via GitGitGadget" Date: Wed, 05 Aug 2020 01:19:05 +0000 Subject: [PATCH v3 2/4] help: drop usage of 'common' and 'useful' for guides Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: =?utf-8?b?Tmd1eeG7hW4gVGjDoWkgTmfhu41j?= Duy , Philip Oakley , Eric Sunshine , SZEDER =?utf-8?b?R8OhYm9y?= , Philippe Blain , Philippe Blain Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Philippe Blain Since 1b81d8cb19 (help: use command-list.txt for the source of guides, 2018-05-20), all man5/man7 guides listed in command-list.txt appear in the output of 'git help -g'. However, 'git help -g' still prefixes this list with "The common Git guides are:", which makes one wonder if there are others! In the same spirit, the man page for 'git help' describes the '--guides' option as listing 'useful' guides, which is not false per se but can also be taken to mean that there are other guides that exist but are not useful. Instead of 'common' and 'useful', use 'Git concept guides' in both places. To keep the code in line with this change, rename help.c::list_common_guides_help to list_guides_help. Signed-off-by: Philippe Blain --- Documentation/git-help.txt | 6 +++--- builtin/help.c | 2 +- help.c | 4 ++-- help.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 69c0c5c34e..44fe8860b3 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -21,8 +21,8 @@ on the standard output. If the option `--all` or `-a` is given, all available commands are printed on the standard output. -If the option `--guides` or `-g` is given, a list of the useful -Git guides is also printed on the standard output. +If the option `--guides` or `-g` is given, a list of the +Git concept guides is also printed on the standard output. If a command, or a guide, is given, a manual page for that command or guide is brought up. The 'man' program is used by default for this @@ -58,7 +58,7 @@ OPTIONS -g:: --guides:: - Prints a list of useful guides on the standard output. This + Prints a list of the Git concept guides on the standard output. This option overrides any given command or guide name. -i:: diff --git a/builtin/help.c b/builtin/help.c index 299206eb57..bb339f0fc8 100644 --- a/builtin/help.c +++ b/builtin/help.c @@ -579,7 +579,7 @@ int cmd_help(int argc, const char **argv, const char *prefix) } if (show_guides) - list_common_guides_help(); + list_guides_help(); if (show_all || show_guides) { printf("%s\n", _(git_more_info_string)); diff --git a/help.c b/help.c index 44cee69c11..d478afb2af 100644 --- a/help.c +++ b/help.c @@ -397,10 +397,10 @@ void list_cmds_by_config(struct string_list *list) } } -void list_common_guides_help(void) +void list_guides_help(void) { struct category_description catdesc[] = { - { CAT_guide, N_("The common Git guides are:") }, + { CAT_guide, N_("The Git concept guides are:") }, { 0, NULL } }; print_cmd_by_category(catdesc, NULL); diff --git a/help.h b/help.h index 500521b908..dc02458855 100644 --- a/help.h +++ b/help.h @@ -21,7 +21,7 @@ static inline void mput_char(char c, unsigned int num) void list_common_cmds_help(void); void list_all_cmds_help(void); -void list_common_guides_help(void); +void list_guides_help(void); void list_all_main_cmds(struct string_list *list); void list_all_other_cmds(struct string_list *list);