From patchwork Wed Jan 22 03:45:40 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "brian m. carlson" X-Patchwork-Id: 11344955 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 603021820 for ; Wed, 22 Jan 2020 03:46:07 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 3515724656 for ; Wed, 22 Jan 2020 03:46:07 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (3072-bit key) header.d=crustytoothpaste.net header.i=@crustytoothpaste.net header.b="opbkWOzh" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729066AbgAVDpy (ORCPT ); Tue, 21 Jan 2020 22:45:54 -0500 Received: from injection.crustytoothpaste.net ([192.241.140.119]:44120 "EHLO injection.crustytoothpaste.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727141AbgAVDpy (ORCPT ); Tue, 21 Jan 2020 22:45:54 -0500 Received: from camp.crustytoothpaste.net (unknown [IPv6:2001:470:b978:101:b610:a2f0:36c1:12e3]) (using TLSv1.2 with cipher ECDHE-RSA-CHACHA20-POLY1305 (256/256 bits)) (No client certificate requested) by injection.crustytoothpaste.net (Postfix) with ESMTPSA id A047D607F7; Wed, 22 Jan 2020 03:45:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=crustytoothpaste.net; s=default; t=1579664753; bh=UVKsYt/9GzBUZj0UgdY6lD//V/UbooCeMLbDbhbQcNM=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From:Reply-To: Subject:Date:To:CC:Resent-Date:Resent-From:Resent-To:Resent-Cc: In-Reply-To:References:Content-Type:Content-Disposition; b=opbkWOzhb/m4vLMuJ69kKqnwvjVXkd1dR/WfNP0om9wXx0ngC7gsrecTe2T1uTroO kPHt9Bw1ZJCXgz64wabCyCXTgUbh6v0f0c/YmcblwtJkgf5UgwOnUVWk19CNy0Digc l2FZltTedZcFtJ9897QwPBX7x5qh2BswFc8a/92pn0XEQEcKRtsP+ahcrBcqyv78fD BIqNg/hEx2dBLIFvj4uchg4ly5++4eWxUbq2UR4msLyx37GBdtXCh2hxT5Jqk/i8sn ktzLnYGj4k/ShI4ShqmChJxscp/FFRhfAFjZalxCDZQzQVVWdXKYCEESOGSK275E4s RU86LnV9kSyGZG+LRhqAStb1Nsl9WwYwWi8NKDWORMTN6YddS/iKt5nCaX3gPFpefw I6FStPlhT/IO14Xqm3Q2xOJFuRnxb8STAMyq1m0VeL+RrV0AwfMcotWLpaqo4jSRe6 MlaX+kB5s4a4AO47GdcuswcIPHEUiZ+9yrygA2xTmnn2Wn80Nz1 From: "brian m. carlson" To: Cc: Jeff King , Junio C Hamano Subject: [PATCH v5 2/5] docs: expand on possible and recommended user config options Date: Wed, 22 Jan 2020 03:45:40 +0000 Message-Id: <20200122034543.18927-3-sandals@crustytoothpaste.net> X-Mailer: git-send-email 2.25.0.341.g760bfbb309 In-Reply-To: <20200122034543.18927-1-sandals@crustytoothpaste.net> References: <20200122034543.18927-1-sandals@crustytoothpaste.net> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org In the section on setting author and committer information, we omit the author.* and committer.* variables, so mention them for completeness. In addition, guide users to the typical case: simply setting user.name and user.email, which are recommended if one does not need complex configuration. Signed-off-by: brian m. carlson --- Documentation/git-commit.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 30c30ccd80..7b61c9ba79 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -482,6 +482,13 @@ system user name and the hostname used for outgoing mail (taken from `/etc/mailname` and falling back to the fully qualified hostname when that file does not exist). +The `author.name` and `committer.name` and their corresponding email options +override `user.name` and `user.email` if set and are overridden themselves by +the environment variables. + +The typical usage is to set just the `user.name` and `user.email` variables; +the other options are provided for more complex use cases. + :git-commit: 1 include::date-formats.txt[]