Bug#339826: homepage pseudofield
Hello Andreas,
I'm still not happy with DevRef WRT the 'homepage' field.
#339826: "Please discuss Homepage padding more fully"
It now has:
Please make sure that this line matches the regular expression
/^ Homepage: [^ ]*$/, as this allows packages.debian.org to parse
it correctly.
But this is wrong IMO, and should be /^ Homepage: [^ ]*$/.
I just checked the CVS and this appears to be a problem with HTML
conversion only.
I don't know how to fix that problem.
But, I'm including a patch which reworks this section, and
. Emphasises that this pseudofield is special, and handled
specially;
. Makes it easier to see the extra indentation;
. Stops discouraging people from using the pseudofield, "because it
will eventually be a real field"
. Gives a fuller example
. Fixes a grammar problem
--
Clear skies,
Justin
--- /tmp/developers-reference.sgml 2005-12-29 20:39:54.000000000 -0500
+++ /tmp/developers-reference.sgml-new 2005-12-29 20:40:07.000000000 -0500
@@ -3833,26 +3833,30 @@
We recommend that you add the URL for the package's home page to the
package description in <file>debian/control</file>. This information
should be added at the
-end of description, using the following format:
+end of the long description, using a special format recognized by
+<file>packages.debian.org</file>. You can see an example of how the
+homepage will be displayed at
+<url id="&url-eg-desc-upstream-info;">.
+
+A package using this field will have have a Description such as:
<example> .
+Description: foo
+ bar
+ .
Homepage: http://some-project.some-place.org/</example>
-Note the spaces prepending the line, which serves to break the lines
-correctly. To see an example of how this displays, see <url
-id="&url-eg-desc-upstream-info;">.
+Note the spaces prepending the last line. Packages using the Homepage
+pseudofield will have <file>debian/control</file> files which match
+the regular expression <tt>/^ Homepage: [^ ]*$/</tt>.
+
<p>
If there is no home page for the software, this should naturally be
left out.
<p>
Note that we expect this field will eventually be replaced by a proper
<file>debian/control</file> field understood by <prgn>dpkg</prgn> and
-<tt>&packages-host;</tt>. If you don't want to bother migrating the
-home page from the description to this field, you should probably wait
-until that is available.
- Please make sure that this line matches the regular expression
- <tt>/^ Homepage: [^ ]*$/</tt>,
- as this allows <file>packages.debian.org</file> to parse it correctly.</p>
+<tt>&packages-host;</tt>.</p>
</sect1>
</sect>
Reply to: