Bug#660193: developers-reference: please suggest debian/rules target name for preparing source
* Russ Allbery [2012-03-16 19:05 -0700]:
> Charles Plessy <plessy@debian.org> writes:
> > Le Fri, Feb 17, 2012 at 02:46:15PM +0100, Carsten Hey a écrit :
>
> >> In general, debian/README.source does not contain information how to
> >> run, for example, autoconf and friends to convert a clean VCS checkout
> >> into a source tree that can be built using dpkg-buildpackage (there are
> >> packages that require this).
>
> > perhaps the Policy could be modified to allow such information
> > in debian/README.source ? There is an open bug on this subject.
>
> > http://bugs.debian.org/495233
>
> I've always been a little surprised that people think that Policy doesn't
> allow such information in README.source ...
This section is structured like this:
if $condition README.source should explain:
* enumeration about what should be explained
remark regarding above explanation
an other remark regarding above explanation
mention possible additional content
After scanning the first two paragraphs below of the enumeration for
useful information, people might skip reading the last paragraph because
they do expect it to only contain further information regarding the
enumeration above.
The section's last paragraph can be displayed in a browser in a way that
easily could be mixed up with a page's footer out of the corner of one's
eyes. There are two reasons for this (one of them alone wouldn't have
this effect), one is that the sections last paragraph is also the last
of this chapter (and thus on the displayed web page) and the other one
is that, depending on the used browser font and window size, there can
be two lines, both starting with the same long and partly uppercased
string, resulting in a structure typically found in footers or copyright
notices, but hardly in body text.
A possible fix for both is to move the last paragraph up, so that the
section starts with this paragraph (which would require minor wording
changes).
Carsten
Reply to: