[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: file/directory named Config in current dir causes waring from texi2a
From: |
Gavin Smith |
Subject: |
Re: file/directory named Config in current dir causes waring from texi2any |
Date: |
Sun, 25 Jun 2023 11:55:59 +0100 |
On Thu, Jun 15, 2023 at 08:36:39PM +0100, Gavin Smith wrote:
> texi2any is looking for an init file called 'Config'. It is documented
> in the texi2any_api manual:
>
> > Warning: The ‘Config’ file related paths and even the use of
> > ‘Config’ files is not definitive.
> >
> > You can write so-called “initialization files”, or “init files” for
> > short, to modify almost every aspect of output formatting. The program
> > loads init files named ‘Config’ each time it is run.
>
> I think that 'Config' is too generic a name for this. We could look at
> naming conventions used for init or run control files by different programs
> and change it to something else.
I propose that the file name should contain "texi2any" to make it clear it is
for the texi2any program. I also suggest that the name not begin with
a period (.) so that the file not be hidden. I expect that a
significant proportion of these config files would be manual-specific and
should be visible.
In Info node (texi2any_api)Init File Basics, it says
Init files are written in Perl, and by convention have extension ‘.init’
or ‘.pm’.
I think "texi2any.init" could be a good name. Another idea is
"texi2any-config.pm" to make it clear it is written in Perl (and, if there
is ever a version of texi2any in the future that is not written in Perl,
would make it clear that the config file is no longer usable).
A similar use case might be a directory specific init file for gdb
called '.gdbinit'. Other uses like user dotfiles (e.g .emacs, .bashrc)
are not comparable as they are not project specific.