Skip to content

Some configuration files should be renamed from `.conf` to `.conf.example`

Just over half of the example configuration files in CTA are named *.conf.example:

$ find . -name '*.example'
./catalogue/cta-catalogue.conf.example
./migration/gRPC/castor-migration.conf.example
./python/eosfstgcd/cta-fst-gcd.conf.example
./tapeserver/daemon/cta-taped.conf.example
./tapeserver/TPCONFIG.example

but we still have a few which are named *.conf:

$ find . -name '*.conf'|grep -v /continuousintegration|grep -v SystemTest
./cmdline/cta-cli.conf
./mediachanger/castorrmc/rmc/cta-rmcd.conf
./mediachanger/castorrmc/rmc/cta-smc.conf
./xroot_plugins/cta-frontend-xrootd.conf

These should be renamed to *.conf.example for consistency.

We should also check that the example files document all the configuration options, show the default values for each option, and make sure that obsolete options are removed. Also, options in example files should be consistent with what is in the man pages.

This has been done already for cta-fst-gcd.conf.example and TPCONFIG.example.

To be renamed and checked

  • ./cmdline/cta-cli.conf
  • ./mediachanger/castorrmc/rmc/cta-rmcd.conf
  • ./mediachanger/castorrmc/rmc/cta-smc.conf
  • ./xroot_plugins/cta-frontend-xrootd.conf

To be checked

  • ./catalogue/cta-catalogue.conf.example
  • ./python/eosfstgcd/cta-fst-gcd.conf.example
Edited by Michael Davis