From patchwork Mon Nov 4 13:08:58 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Pratyush Yadav X-Patchwork-Id: 11225767 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 6B58D913 for ; Mon, 4 Nov 2019 13:09:05 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 4812221D7F for ; Mon, 4 Nov 2019 13:09:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728772AbfKDNJE (ORCPT ); Mon, 4 Nov 2019 08:09:04 -0500 Received: from relay10.mail.gandi.net ([217.70.178.230]:50545 "EHLO relay10.mail.gandi.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727430AbfKDNJE (ORCPT ); Mon, 4 Nov 2019 08:09:04 -0500 Received: from localhost.localdomain (unknown [1.186.12.17]) (Authenticated sender: me@yadavpratyush.com) by relay10.mail.gandi.net (Postfix) with ESMTPSA id 0A473240006; Mon, 4 Nov 2019 13:09:00 +0000 (UTC) From: Pratyush Yadav To: Cc: Junio C Hamano Subject: [PATCH v2] git-shortlog.txt: include commit limiting options Date: Mon, 4 Nov 2019 18:38:58 +0530 Message-Id: <20191104130858.23673-1-me@yadavpratyush.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20191030203603.27497-1-me@yadavpratyush.com> References: <20191030203603.27497-1-me@yadavpratyush.com> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org git-shortlog, like git-log, supports options to filter what commits are used to generate the log. These options come from git-rev-list, and are documented in Documentation/rev-list-options.txt. Include those options in shortlog's documentation. But since rev-list-options.txt contains some other options that don't really apply in the context of shortlog (like diff formatting, commit ordering, etc), add a switch in rev-list-options.txt that excludes those sections from the shortlog documentation. To be more specific, include only the "Commit Limiting" section. Signed-off-by: Pratyush Yadav --- That ifdef covers almost the entire document. Is there a better way in Asciidoc to do something like this? Documentation/git-shortlog.txt | 3 +++ Documentation/rev-list-options.txt | 2 ++ 2 files changed, 5 insertions(+) -- 2.21.0 diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt index bc80905a8a..a72ea7f7ba 100644 --- a/Documentation/git-shortlog.txt +++ b/Documentation/git-shortlog.txt @@ -76,6 +76,9 @@ them. Paths may need to be prefixed with `--` to separate them from options or the revision range, when confusion arises. +:git-shortlog: 1 +include::rev-list-options.txt[] + MAPPING AUTHORS --------------- diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt index 90ff9e2bea..f4b67a917d 100644 --- a/Documentation/rev-list-options.txt +++ b/Documentation/rev-list-options.txt @@ -314,6 +314,7 @@ ifdef::git-rev-list[] `
` text will be printed with each progress update. endif::git-rev-list[] +ifndef::git-shortlog[] History Simplification ~~~~~~~~~~~~~~~~~~~~~~ @@ -1016,3 +1017,4 @@ options may be given. See linkgit:git-diff-files[1] for more options. -t:: Show the tree objects in the diff output. This implies `-r`. endif::git-rev-list[] +endif::git-shortlog[]