diff options
| author | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2021-03-22 21:53:30 +0100 |
|---|---|---|
| committer | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2021-03-22 21:53:30 +0100 |
| commit | 12433f49781a47df3219483b3200409b80ddd97f (patch) | |
| tree | c66f451372050008f86434cc4d4d21cd9f7fecf0 | |
| parent | 173c73a7a82c05076de78ca4a6e468f7a84f7476 (diff) | |
Update lesana init manpage with the git hooks
| -rw-r--r-- | docs/source/man/lesana-init.rst | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/source/man/lesana-init.rst b/docs/source/man/lesana-init.rst index c21ef1c..f6149b3 100644 --- a/docs/source/man/lesana-init.rst +++ b/docs/source/man/lesana-init.rst @@ -13,8 +13,9 @@ DESCRIPTION lesana init initializes a new lesana collection. It will create the directory (if it does not exist) and, unless -``--no-git`` is specified it will initialize it as a git repository and -create a ``.gitignore`` file with some relevant contents. +``--no-git`` is specified it will initialize it as a git repository, +create a ``.gitignore`` file with some relevant contents and add hooks +to update the local cache when the files are changed via git. It will then create a skeleton ``settings.yaml`` file and open it in an editor to start configuring the collection. @@ -22,6 +23,10 @@ editor to start configuring the collection. When leaving the editor, again unless ``--no-git`` is used, it will add this file to the git staging area, but not commit it. +It is safe to run this command on an existing repository, e.g. to +install the hooks on a new clone, but it will overwrite the hooks +themselves even if they have been changed by the user. + OPTIONS ======= |