Re: Line breaks in @file{} entries?

[Carl Sorensen]

On 11/26/10 3:37 AM, "Valentin Villenave" <address@hidden> wrote:

> On Fri, Nov 26, 2010 at 8:44 AM, Trevor Daniels <address@hidden> wrote:
>> I'd prefer this patch to be reverted.  That way the information about
>> the long filenames that previously contained @/s is retained, making
>> it easier to change these to @examples (if this is indeed desirable).
> 
> Hmm, tricky. I get your point: in some sense, information has been
> lost. How really relevant was that information, however? There were
> some long filenames with @/ others without, and it wasn't even
> consistent between translations of a same file. In many files, slashes
> and dashes were "escaped" in the @seealso section, *but* not in the
> main text where these are actually needed!
> 
> Besides, as I said, this patch doesn't just add @/ everywhere, it also
> adds quite a bunch of @file{} items (in many places where @code{} was
> previously used, or even nothing at all -- for example, have a look at
> the modifications in input.itely:
> http://git.savannah.gnu.org/gitweb/?p=lilypond.git;a=commitdiff;h=1b832d794f14
> 44033f10465971e97d33f76fe310#patch42).

With such a big patch, this is an example of a patch that should likely have
been two patches:

1) Fix all the @file references (i.e. from @code, etc.)

2) Insert the line breaks where appropriate.

Then we could have handled the two cases separately.

This is something I continually have trouble with.  I tend to make big
patches, when I should be focusing on small patches.  Not only is it easier
to review, it's easier to adjust.

Thanks,

Carl