diff options
| author | Simon McVittie <smcv@debian.org> | 2015-03-01 16:14:32 +0000 |
|---|---|---|
| committer | Simon McVittie <smcv@debian.org> | 2015-03-01 16:15:01 +0000 |
| commit | a1fda0b516cc4e85b7304838949df8fbe0044cf3 (patch) | |
| tree | cc1a5cade5f89ad2386cd39e8f1e319875c61b8f /doc/tips/optimising_ikiwiki.mdwn | |
| parent | 0700b26b58bac8670b21afb502540c61deac3065 (diff) | |
| download | ikiwiki-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/tips/optimising_ikiwiki.mdwn')
| -rw-r--r-- | doc/tips/optimising_ikiwiki.mdwn | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/tips/optimising_ikiwiki.mdwn b/doc/tips/optimising_ikiwiki.mdwn index cf412d266..6e8b60617 100644 --- a/doc/tips/optimising_ikiwiki.mdwn +++ b/doc/tips/optimising_ikiwiki.mdwn @@ -17,19 +17,19 @@ it's slow, and get the problem fixed!) Are you building your wiki by running a command like this? - ikiwiki -setup my.setup + ikiwiki --setup my.setup If so, you're always telling ikiwiki to rebuild the entire site, from scratch. But, ikiwiki is smart, it can incrementally update a site, building only things affected by the changes you make. You just have to let it do so: - ikiwiki -setup my.setup -refresh + ikiwiki --setup my.setup --refresh Ikiwiki automatically uses an incremental refresh like this when handing a web edit, or when run from a [[rcs]] post-commit hook. (If you've configured the hook in the usual way.) Most people who have run into this -problem got in the habit of running `ikiwiki -setup my.setup` by hand +problem got in the habit of running `ikiwiki --setup my.setup` by hand when their wiki was small, and found it got slower as they added pages. ## use the latest version @@ -174,7 +174,7 @@ Finally, let's think about how huge number of pages can affect ikiwiki. command. Obviously, more files will make it take longer. You can avoid this scanning overhead, if you're using git, by setting - `only_committed_changes`. This makes ikiwiki -refresh query git for + `only_committed_changes`. This makes ikiwiki --refresh query git for changed files since the last time, which tends to be a lot faster. However, it only works if all files in your wiki are committed to git (or stored in the [[/plugins/transient]] underlay). |