Skip to content

Commit e72ec3d

Browse files
committed
document result of running save-config in a tracker home directory
1 parent 3eabbda commit e72ec3d

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

doc/admin_guide.txt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,8 +232,12 @@ roundup-server command line use::
232232

233233
Note it will save an old config.ini file to config.bak and create a
234234
new config.ini. The file is recreated from scratch ignoring the
235-
contents of the current config.ini. You may need to merge the
236-
backup and config files.
235+
contents of the current config.ini. You may need to merge the backup
236+
and config files. save-config doesn't attempt to load or verify an
237+
existing config.ini. Running this in a tracker home directory will
238+
move the exsiting config.ini to config.bak and replace it with the
239+
roundup-server's config.ini. This will make the tracker in the
240+
directory fail to start util the original config.ini is restored.
237241

238242
Configuring Compression
239243
=======================

share/man/man1/roundup-server.1

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,12 @@ Print version and exit.
7878
Print help and exit.
7979
.TP
8080
\fB--save-config\fP
81-
Create or update configuration file and exit.
81+
Create configuration file and exit. The old config.ini will be saved to
82+
config.bak. Note that this command doesn't attempt to load or verify
83+
an existing config.ini. Running this in a tracker home directory will
84+
move the existing config.ini to config.bak and replace it with the
85+
roundup-server's config.ini. This will make the tracker in the
86+
directory fail to start until the original config.ini is restored.
8287
.TP
8388
\fBname=\fP\fItracker home\fP
8489
Sets the tracker home(s) to use. The \fBname\fP variable is how the tracker is

0 commit comments

Comments
 (0)