[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

documentation/2174: checklist.html, DESCR should be 80 characters wide




>Number:         2174
>Category:       documentation
>Synopsis:       checklist.html, DESCR should be 80 characters wide
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    bugs
>State:          open
>Class:          change-request
>Submitter-Id:   net
>Arrival-Date:   Mon Nov 12 04:30:01 MST 2001
>Last-Modified:
>Originator:     Nick Nauwelaerts
>Organization:
>Release:        OpenBSD-current
>Environment:
	
	System      : OpenBSD 3.0-current
	Architecture: OpenBSD.i386
	Machine     : i386
>Description:
As previously reported on ports@openbsd.org it's a good idea to wrap the linewidth of the pkg/DESCR file to about 80 characters, this can be done easily by using fmt. Since I have often wondered about this as well perhaps it's a good idea to add it to the documentation, checklist.html is this case.
>How-To-Repeat:
N.A.
>Fix:
--- checklist.html.orig Mon Nov 12 12:04:41 2001
+++ checklist.html      Mon Nov 12 12:07:04 2001
@@ -308,7 +308,9 @@
 <ul>
 <li>
 DESCR is a longer description of the port. One to a few paragraphs
-concisely explaining what the port does is sufficient.
+concisely explaining what the port does is sufficient. It is also advised to
+wrap your lines at 80 characters. This can be done by first editing the DESCR
+file and then running it through 'fmt -w 80'.
 <li>
 PLIST is kept empty at this point.
 </ul>

>Audit-Trail:
>Unformatted: