From eaeb48bd206d3525bcee5dcc4d2f49bf9c3ba58c Mon Sep 17 00:00:00 2001 From: Olivier Mangin Date: Sat, 8 Jun 2019 09:48:35 -0700 Subject: [PATCH] Minor readme and config update on git plugin. --- pubs/config/spec.py | 8 ++++---- readme.md | 12 +++++++++++- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/pubs/config/spec.py b/pubs/config/spec.py index 59a3cc0..4c50f4c 100644 --- a/pubs/config/spec.py +++ b/pubs/config/spec.py @@ -77,7 +77,7 @@ pages = string(default='') [plugins] # Comma-separated list of the plugins to load. -# The only current available plugin is alias. +# Currently pubs comes with built-in plugins alias and git. active = force_list(default=list('alias')) [[alias]] @@ -99,12 +99,12 @@ active = force_list(default=list('alias')) # The git plugin will commit changes to the repository in a git repository # created at the root of the pubs directory. All detected changes will be # commited every time a change is made by a pubs command. -# The plugin also propose the `pubs git` subcommand, to directory send git -# command to the pubs repository. Therefore, `pubs git status` is equivalent +# The plugin also propose the `pubs git` subcommand, to directly send git +# commands to the pubs repository. Therefore, `pubs git status` is equivalent # to `git -C status`, with the `-C` flag instructing # to invoke git as if the current directory was . Note that a # limitation of the subcommand is that you cannot use git commands with the -# `-c` option (pubs will interpret it first.) +# `-c` option (pubs will interpret it first.) # if False, will display git output when automatic commit are made. # Invocation of `pubs git` will always have output displayed. diff --git a/readme.md b/readme.md index 6cf6085..44210b9 100644 --- a/readme.md +++ b/readme.md @@ -95,6 +95,16 @@ And open your documents automatically from the command line: pubs doc open --with lp Loeb_2012 # Opens the document with `lp` to actually print it. ``` +## Versioning + +Pubs comes with a git plugin that automatically commits your changes. You only need to activate it in your configuration: + ```ini + [plugins] + active = git, + ``` + +You can then also conveniently interact with the git repository by using `pubs git `. + ## Customization Pubs is designed to interact well with your command line tool chain. @@ -145,4 +155,4 @@ You can access the self-documented configuration by using `pubs conf`, and all t - [Bill Flynn](https://github.com/wflynny) - [Kyle Sunden](https://github.com/ksunden) - [Shane Stone](https://github.com/shanewstone) -- [Amlesh Sivanantham](http://github.com/zamlz) \ No newline at end of file +- [Amlesh Sivanantham](http://github.com/zamlz)