From 0c476ca4a9cb91568258934f6abf634e49dfaabd Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Mon, 9 Oct 2023 08:16:00 -0400 Subject: [PATCH] docs: document the `scriv.user_nick` git setting. --- .../20231003_082812_ronny_user_nick_setting.rst | 7 +++---- docs/configuration.rst | 10 ++++++++++ 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/changelog.d/20231003_082812_ronny_user_nick_setting.rst b/changelog.d/20231003_082812_ronny_user_nick_setting.rst index 2bffea6..f05c10a 100644 --- a/changelog.d/20231003_082812_ronny_user_nick_setting.rst +++ b/changelog.d/20231003_082812_ronny_user_nick_setting.rst @@ -1,10 +1,9 @@ - Added ..... -- consider the git config ``scriv.user_nick`` for the user nick part - of the fragment file - thanks to `Ronny Pfannschmidt `_, fixing `issue 103`_ - +- Use the git config ``scriv.user_nick`` for the user nick part + of the fragment file. Thanks to `Ronny Pfannschmidt `_, + fixing `issue 103`_. .. _issue 103: https://github.com/nedbat/scriv/pull/103 .. _pull 106: https://github.com/nedbat/scriv/pull/106 diff --git a/docs/configuration.rst b/docs/configuration.rst index 3444c3d..04e4e11 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -378,6 +378,9 @@ Per-User Git Settings Some aspects of scriv's behavior are configurable for each user rather than for the project as a whole. These settings are read from git. +Editing and Adding +------------------ + These settings determine whether the ":ref:`cmd_create`" and ":ref:`cmd_collect`" commands will launch an editor, and "git add" the result: @@ -395,6 +398,13 @@ or globally for all of your repos:: $ git config --global scriv.create.edit true +User nickname +------------- + +Scriv includes your git or GitHub username in the file names of changelog +fragments you create. If you don't like the name it finds for you, you can set +a name as the ``scriv.user_nick`` git setting. + .. _git config: https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration