On 2021-11-22 16:29:35, Oswald Buddenhagen wrote:
> On Mon, Nov 22, 2021 at 09:29:13AM -0500, Antoine Beaupré wrote:
>>hehe. well, it's a matter of taste I guess. i also don't like
>>excessively long manual pages either, but in this case this can fairly
>>easily be solved by moving the configuration file documentation to a
>>`mbsyncrc(5)` manpage. The examples could live there or in the main
>>manpage. Or at least refer to the shipped examples file.
>
> most of the manual is about the config file, so that wouldn't *really*
> solve the problem (having the example in the main page would be kinda
> backwards). but i like the idea of referring to the example file (i've
> seen precedents for that on my debian system), so that's a settled
> matter anyway. ^^
i still think the config file docs should be split out, TBH. the example
could live there too. but it's your call. :)
>>of course. i guess what i would like to see is a single summary line,
>>at the end of the job. basically the last printf would be enough, i
>>would guess.
>
> that's a good idea. i'll even make it a bit more human-readable.
that's amazing, and unexpected, thanks! :)
>>what i find really confusing about the config file syntax is that
>>sections are really not obvious at first. it's really a trial-and-error
>>process to generate a valid configuration file, and i think that could
>>be improved.
>
> the manual explains it thoroughly and the example file kinda hints at it
> (though i could make it more explicit), so someone approaching the whole
> thing more systematically shouldn't have a problem. :P
yeah, i guess that's my point. when I was 20 years younger, I had a lot
more time on my hands and didn't mind things like that. i would learn
everything about everything, and that worked. now, i'm much less patient
and expect things to just work out of the box without me having to
figure out what a "channel" is. :)
>>*not* using a DSL and instead a more "standard" format would help...
>>
> well, that ship has kinda sailed even before i took over the project.
> and i don't see this as a big enough pain point to warrant a format
> change.
sure, that's not something I think you can fix easily, and probably does
not warrant a major change, unless it would also fix other
limitations. it's just one of those little quirks every project has,
basically...
a.
--
We will create a civilization of the Mind in Cyberspace. May it be more
humane and fair than the world your governments have made before.
- John Perry Barlow, 1996
A Declaration of Independence of Cyberspace
_______________________________________________
isync-devel mailing list
isync-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/isync-devel
