Hi Oswald, On Fri, Jan 24, 2025 at 05:00:52PM +0100, Oswald Buddenhagen wrote: > > I didn't know what to do, or if it was even my fault. > > > that seems rather weird to me, having thought that the message is > entirely self-explanatory.
The main problem I see is that the diagnostic doesn't show the file and
line. The error message is this:
Notice: SSLType is deprecated. Use TLSType instead.
However, for errors in the file, I see messages like this one:
/home/alx/.mbsyncrc:6: keyword 'SLType' is not recognized in
IMAPAccount sections
With the latter, it's obvious that the problem is mine, in the location
specified by the pathname and line. With the former, I might confuse it
for an internal error notice.
> > I would keep a HISTORY section in the manual page,
> >
> that might make sense for options that changed semantically rather than
> just being renamed.
For something renamed, I'd add a short line like this:
SSLType
Deprecated synonym for TLSType.
It doesn't take too much space, and documents the transition.
> other than that, the assumption is that the person who put the options
> there will recognize what they meant.
If I put that many years ago, I might forget what it meant. :)
> people who need reminders tend to
> put such into comments.
I tend to avoid comments if the manual page specifies what something
means. The manual page will be kept up-to-date, while my comment will
get stale.
Have a lovely day!
Alex
P.S.: Sorry for not responding before. I had fever last week. :)
--
<https://www.alejandro-colomar.es/>
signature.asc
Description: PGP signature
