Skip to content

Commit

Permalink
docs: document the scriv.user_nick git setting.
Browse files Browse the repository at this point in the history
  • Loading branch information
Ned Batchelder committed Oct 9, 2023
1 parent 4630d8c commit 0c476ca
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
7 changes: 3 additions & 4 deletions changelog.d/20231003_082812_ronny_user_nick_setting.rst
Original file line number Diff line number Diff line change
@@ -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 <pull 106>`_, fixing `issue 103`_

- Use the git config ``scriv.user_nick`` for the user nick part
of the fragment file. Thanks to `Ronny Pfannschmidt <pull 106>`_,
fixing `issue 103`_.

.. _issue 103: https://github.com/nedbat/scriv/pull/103
.. _pull 106: https://github.com/nedbat/scriv/pull/106
10 changes: 10 additions & 0 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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

Expand Down

0 comments on commit 0c476ca

Please sign in to comment.