From patchwork Sun Aug 2 15:20:46 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: 11696541 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 13CB714B7 for ; Sun, 2 Aug 2020 15:21:00 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id F1E2F207BB for ; Sun, 2 Aug 2020 15:20:59 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="rw4LSFf+" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726987AbgHBPU6 (ORCPT ); Sun, 2 Aug 2020 11:20:58 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45870 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726819AbgHBPUw (ORCPT ); Sun, 2 Aug 2020 11:20:52 -0400 Received: from mail-wm1-x341.google.com (mail-wm1-x341.google.com [IPv6:2a00:1450:4864:20::341]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 13384C061757 for ; Sun, 2 Aug 2020 08:20:52 -0700 (PDT) Received: by mail-wm1-x341.google.com with SMTP id c19so2248080wmd.1 for ; Sun, 02 Aug 2020 08:20:52 -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=rw4LSFf+UwiMaZ2skRe4V6jB8qX9wmuVfEB6mU1uTw3IcUYp3c/IuIk6gtVUTtOfxI iQd3XdL266hIJ6BAXQz4oh9fxGXcNzmNoyhswAmU+5zhSGrSge4xJ3Homulk1CVkGB9l yKNLsfsO5oipTqkD6YkftxmmnT5wZ18X4Cr1ii0DjAiM/i7mzuNH4ddkpY++RfbIJc7T weTA1PsWBL64a90OAcjeUjT6UGwNhf7F4pbwe50egQ9+ECO3j9u1klowRp/8p/Pu3pGI kaZ5Y3KKi+IU4Dlm7opObeLWEENm3yRi+In3/HrLUZp6GiTaODHqZoBBQ5dJN71sxqSB 5ZMQ== 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=jPbehssyKD7kC90vez9IDhZDRKfU0SEi6QY0oKaMY0jK/RXPPxipGZwM//vsRTpWWF OfD4qGzz8JP8RWmYFO60pVT8afEtRBDhYuy74exWWW6b3n0ubxNAZinWWsjlcV7RNDtI CoZgbvCvUp7yrlq+pkD/+Mn0set7TyVl1m5XLMhqiefT8kxDNNTA5Gj+I1yosdvHMpD2 hmV1BelJ854Gj/QzAreWtGKwi1iD+y8rg3iQr41M6WePjAEX2vEwswf+2b87gfHpyjVf azGppEsbCnB9EkYqBmofeuy7KWRWj3OYQ0UT9zci2f6zzMnD7AmQKwy3pH3nDp3yeGXl 0i+A== X-Gm-Message-State: AOAM531pm3L+Hip0x5pFIWta1MqJozO1EpslaEfYldm5BVG65e/ivQwJ ALqrKWhQ/hAagJeoHJgtoczxVk3w X-Google-Smtp-Source: ABdhPJwyw1g6R1rsBs8cTnsbMrDMMdzkYl4fegYjzUSePcV9XRnTQ4mXxrbZFcru5kE0ZHDakcfQRQ== X-Received: by 2002:a1c:bd04:: with SMTP id n4mr12863733wmf.83.1596381650702; Sun, 02 Aug 2020 08:20:50 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id p14sm20420192wrg.96.2020.08.02.08.20.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 02 Aug 2020 08:20:50 -0700 (PDT) Message-Id: In-Reply-To: References: From: "Philippe Blain via GitGitGadget" Date: Sun, 02 Aug 2020 15:20:46 +0000 Subject: [PATCH 2/3] 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);