Fix commands.rst - Githubissues

cyrusimap / cyrus-imapd

Cyrus IMAP is an email, contacts and calendar server

http://cyrusimap.org

Other

538 stars 148 forks source link

Fix commands.rst #2007

Closed nicolan closed 7 years ago

nicolan commented 7 years ago

commands.rst references a bunch of files which are marked as hidden from TOC

Why are they hidden? Work out which ones are old/obsolete/unnecessary and remove. Work out which ones are necessary and clean them up for formal inclusion.

nicolan commented 7 years ago

[x] systemcommands/compile_st.pl
[x] systemcommands/cyr_systemd_helper
[x] systemcommands/convert-sieve.pl
[x] systemcommands/masssievec
[x] systemcommands/arbitronsort.pl
[x] systemcommands/fixsearchpath.pl
[x] systemcommands/migrate-metadata
[x] systemcommands/mknewsgroups
[x] systemcommands/mupdate-loadgen.pl
[x] systemcommands/rehash
[x] systemcommands/cvt_cyrusdb_all
[x] systemcommands/cyr_userseen
[x] systemcommands/dohash
[x] systemcommands/undohash
[x] systemcommands/upgradesieve
[x] systemcommands/translatesieve
[x] systemcommands/template

nicolan commented 7 years ago

compile_st.pl - lives in tools. Looks like it's used by the Makefile to set up magic stuff. Does not need user-visible docs. Could probably do with more comments in the file though.

nicolan commented 7 years ago

cyr_systemd_helper - can't find any evidence of this file/tool anywhere. Removing help stub.

nicolan commented 7 years ago

Remove convert-sieve.pl and convert-sieve.pl.rst - translatesieve does everything convert-sieve.pl did, and more!

nicolan commented 7 years ago

masssievec is documented.

nicolan commented 7 years ago

arbitronsort.pl is documented. Moved to usercommands.

nicolan commented 7 years ago

mknewsgroups is documented.

nicolan commented 7 years ago

Removed mupdate-loadgen - test script Removed migrate-metadata - very old. For updating from 1.6.2 (!!) Removed upgradesieve - too old. considered harmful.

nicolan commented 7 years ago

fixsearchpath.pl - vital part of the configure/make install process. Not generally run by hand. Not supplying a manpage as a result!

nicolan commented 7 years ago

cyr_userseen is useful. Is documented.

nicolan commented 7 years ago

template can stay, but fixed the manpages filesystem interrogation to obey exclude_pattern so it won't be built into a manpage or html.

nicolan commented 7 years ago

cvt_cyrusdb_all appears to be a redhat/other distro script, not part of core cyrus

nicolan commented 7 years ago

dohash/undohash removed. obsolete (their info mentions upgrading from cyrus 1.6.2)

nicolan commented 7 years ago

rehash has some docs now written. They're a bit thin - I had to interpolate from source code, commit logs and mailing lists.

nicolan commented 7 years ago

commands list is no longer explicit - use glob to pull in the directory contents.

nicolan commented 7 years ago

proxyd split off into #2019

nicolan commented 7 years ago

PRs are merged for master and 3.0. Closing.