aboutsummaryrefslogtreecommitdiff
path: root/doc/rcs
diff options
context:
space:
mode:
authorSimon McVittie <smcv@debian.org>2015-03-01 16:14:32 +0000
committerSimon McVittie <smcv@debian.org>2015-03-01 16:15:01 +0000
commita1fda0b516cc4e85b7304838949df8fbe0044cf3 (patch)
treecc1a5cade5f89ad2386cd39e8f1e319875c61b8f /doc/rcs
parent0700b26b58bac8670b21afb502540c61deac3065 (diff)
downloadikiwiki-a1fda0b516cc4e85b7304838949df8fbe0044cf3.tar
ikiwiki-a1fda0b516cc4e85b7304838949df8fbe0044cf3.tar.gz
Standardize on --long-option instead of -long-option
[[forum/refresh_and_setup]] indicates some confusion between --setup and -setup. Both work, but it's clearer if we stick to one in documentation and code. A 2012 commit to [[plugins/theme]] claims that "-setup" is required and "--setup" won't work, but I cannot find any evidence in ikiwiki's source code that this has ever been the case.
Diffstat (limited to 'doc/rcs')
-rw-r--r--doc/rcs/git.mdwn6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/rcs/git.mdwn b/doc/rcs/git.mdwn
index c82adbd04..fa7a037ba 100644
--- a/doc/rcs/git.mdwn
+++ b/doc/rcs/git.mdwn
@@ -108,13 +108,13 @@ is the normal behaviour of ikiwiki, set the configuration of the local wiki:
git_wrapper => "/working/dir/.git/hooks/post-commit",
Then just committing should refresh the private ikiwiki on the local
-host. Now just run `ikiwiki -setup localwiki.setup -gettime` and
-you should be good to go. (You only need the slow `-gettime` option
+host. Now just run `ikiwiki --setup localwiki.setup --gettime` and
+you should be good to go. (You only need the slow `--gettime` option
the first time you run setup.) Use standard git commands to handle
pulling from and pushing to the server. **Note**: After
pulling changes from the bare root repository, you will need to
manually update the local wiki, with a command such as `ikiwiki
--setup localwiki.setup -refresh`. You could use git's `post-merge` hook
+--setup localwiki.setup --refresh`. You could use git's `post-merge` hook
to automate that command.
## Using ikiwiki with Gerrit