From owner-freebsd-ports Sat Oct 20 8: 0:33 2001 Delivered-To: freebsd-ports@hub.freebsd.org Received: from freefall.freebsd.org (freefall.FreeBSD.org [216.136.204.21]) by hub.freebsd.org (Postfix) with ESMTP id 40E5637B405 for ; Sat, 20 Oct 2001 08:00:04 -0700 (PDT) Received: (from gnats@localhost) by freefall.freebsd.org (8.11.4/8.11.4) id f9KF04q64026; Sat, 20 Oct 2001 08:00:04 -0700 (PDT) (envelope-from gnats) Received: from smtp.noos.fr (verlaine.noos.net [212.198.2.73]) by hub.freebsd.org (Postfix) with ESMTP id 3E0CB37B403 for ; Sat, 20 Oct 2001 07:57:50 -0700 (PDT) Received: (qmail 39375308 invoked by uid 0); 20 Oct 2001 14:57:47 -0000 Received: from unknown (HELO gits.dyndns.org) ([212.198.231.37]) (envelope-sender ) by 212.198.2.73 (qmail-ldap-1.03) with DES-CBC3-SHA encrypted SMTP for ; 20 Oct 2001 14:57:47 -0000 Received: (from root@localhost) by gits.dyndns.org (8.11.6/8.11.6) id f9KEvkh77056; Sat, 20 Oct 2001 16:57:46 +0200 (CEST) (envelope-from root) Message-Id: <200110201457.f9KEvkh77056@gits.dyndns.org> Date: Sat, 20 Oct 2001 16:57:46 +0200 (CEST) From: Cyrille Lefevre Reply-To: Cyrille Lefevre To: FreeBSD-gnats-submit@freebsd.org X-Send-Pr-Version: 3.113 Subject: ports/31389: tidy readme templates + port readme enhancements Sender: owner-freebsd-ports@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.org >Number: 31389 >Category: ports >Synopsis: tidy readme templates + port readme enhancements >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-ports >State: open >Quarter: >Keywords: >Date-Required: >Class: change-request >Submitter-Id: current-users >Arrival-Date: Sat Oct 20 08:00:01 PDT 2001 >Closed-Date: >Last-Modified: >Originator: Cyrille Lefevre >Release: FreeBSD 4.4-RC i386 >Organization: ACME >Environment: System: FreeBSD gits 4.4-RC FreeBSD 4.4-RC #7: Thu Sep 20 12:40:17 CEST 2001 root@gits:/disk2/4.x-stable/src/sys/compile/CUSTOM i386 >Description: first of all, README.* files have been run through tidy since they aren't HTML compliant at all. Mk/bsd.port.mk / ${.CURDIR}/README.html ^A and ^B have been replaced by | to avoid printing problems. long lines have been wrapped. useless use of cat deleted. %%EMAIL%%, %%MAINTAINER%% (not used yet), and %%WEBSITE%% added. pretty-print-www-site target added. Templates/README.* run throught tidy -i since they are malformed HTML. Templates/README.port %%PKG%% moved. %%WEBSITE%%, %%EMAIL%% and port mailing-list added. >How-To-Repeat: cd /usr/ports/textproc/dico make readme >Fix: Index: Mk/bsd.port.mk =================================================================== RCS file: /home/ncvs/ports/Mk/bsd.port.mk,v retrieving revision 1.383 diff -u -r1.383 bsd.port.mk --- Mk/bsd.port.mk 2001/10/09 07:37:34 1.383 +++ Mk/bsd.port.mk 2001/10/20 14:52:48 @@ -2839,16 +2839,25 @@ ${.CURDIR}/README.html: @${ECHO_MSG} "===> Creating README.html for ${PKGNAME}" - @${CAT} ${TEMPLATES}/README.port | \ - ${SED} -e 's%%PORT%%'`${ECHO} ${.CURDIR} | ${SED} -e 's.*/\([^/]*/[^/]*\)$$\1'`'g' \ - -e 's%%PKG%%${PKGNAME}g' \ + @${SED} -e 's|%%PORT%%|'$$(${ECHO} ${.CURDIR} | \ + ${SED} -e 's|.*/\([^/]*/[^/]*\)$$|\1|')'|g' \ + -e 's|%%PKG%%|${PKGNAME}|g' \ -e '/%%COMMENT%%/r${COMMENT}' \ -e '/%%COMMENT%%/d' \ - -e 's%%DESCR%%'"`${ECHO} ${DESCR} | ${SED} -e 's${.CURDIR}/'`"'' \ - -e 's%%BUILD_DEPENDS%%'"`cd ${.CURDIR} && ${MAKE} ${__softMAKEFLAGS} pretty-print-build-depends-list`"'' \ - -e 's%%RUN_DEPENDS%%'"`cd ${.CURDIR} && ${MAKE} ${__softMAKEFLAGS} pretty-print-run-depends-list`"'' \ - -e 's%%TOP%%'"`${ECHO} ${CATEGORIES} | ${SED} -e 'sa .*aa' -e 'sa[^/]*a..ag'`"'/..' \ - >> $@ + -e 's|%%DESCR%%|'"$$(${ECHO} ${DESCR} | \ + ${SED} -e 's|${.CURDIR}/||')"'|' \ + -e 's|%%EMAIL%%|'"$$(${ECHO} "${MAINTAINER}" | \ + ${SED} -e 's/([^)]*)//;s/.*.*//')"'|g' \ + -e 's|%%MAINTAINER%%|${MAINTAINER}|g' \ + -e 's|%%WEBSITE%%|'"$$(cd ${.CURDIR} && ${MAKE} \ + ${__softMAKEFLAGS} pretty-print-www-site)"'|' \ + -e 's|%%BUILD_DEPENDS%%|'"$$(cd ${.CURDIR} && ${MAKE} \ + ${__softMAKEFLAGS} pretty-print-build-depends-list)"'|' \ + -e 's|%%RUN_DEPENDS%%|'"$$(cd ${.CURDIR} && ${MAKE} \ + ${__softMAKEFLAGS} pretty-print-run-depends-list)"'|' \ + -e 's|%%TOP%%|'"$$(${ECHO} ${CATEGORIES} | \ + ${SED} -e 's| .*||' -e 's|[^/]*|..|g')"'/..|' \ + ${TEMPLATES}/README.port >> $@ # The following two targets require an up-to-date INDEX in ${PORTSDIR} @@ -2869,6 +2878,16 @@ @${ECHO} -n `${GREP} '^${PKGNAME}|' ${PORTSDIR}/INDEX | awk -F\| '{print $$9;}'` @${ECHO} '" to run.' .endif +.endif + +.if !target(pretty-print-www-site) +pretty-print-www-site: + @www_site=$$(cd ${.CURDIR} && ${MAKE} ${__softMAKEFLAGS} www-site); \ + if [ -n "$${www_site}" ]; then \ + ${ECHO} -n " and/or visit the "; \ + ${ECHO} -n "web site"; \ + ${ECHO} " for futher informations"; \ + fi .endif # Generate packing list. Also tests to make sure all required package Index: Templates/README.category =================================================================== RCS file: /home/ncvs/ports/Templates/README.category,v retrieving revision 1.3 diff -u -r1.3 README.category --- Templates/README.category 2000/10/14 11:03:19 1.3 +++ Templates/README.category 2001/10/20 14:29:29 @@ -1,27 +1,35 @@ + + - The FreeBSD Ports Collection (%%CATEGORY%%) -

The FreeBSD Ports Collection ("%%CATEGORY%%")

- + + The FreeBSD Ports Collection (%%CATEGORY%%) + + + +

The FreeBSD Ports Collection ("%%CATEGORY%%")

+
-

You are now in the directory "%%CATEGORY%%". +

You are now in the directory "%%CATEGORY%%".

-

This is the one-line description for this category: +

This is the one-line description for this category:

+
-

+

%%COMMENT%% -

+

+
-

+

%%DESCR%% +

-

Here are the one-line descriptions for each items in this directory: - -

-

+    
Here are the one-line descriptions for each items in this
+    directory:

+    

+
 %%SUBDIR%%
 

-
-

- Go to parent directory
-
+    

+    Go to parent directory
+  
 
Index: Templates/README.port
===================================================================
RCS file: /home/ncvs/ports/Templates/README.port,v
retrieving revision 1.3
diff -u -r1.3 README.port
--- Templates/README.port	2000/10/01 17:27:40	1.3
+++ Templates/README.port	2001/10/20 14:51:10
@@ -1,30 +1,43 @@
+
+
 
- The FreeBSD Ports Collection (%%PORT%%)
-
 The FreeBSD Ports Collection ("%%PORT%%")
  

-
+  
+    The FreeBSD Ports Collection (%%PORT%%)
+  
+
+  
+    
The FreeBSD Ports Collection (%%PORT%%)

+    

 
-
You are now in the directory for the port "%%PORT%%" (package name "%%PKG%%").
+    
You are now in the directory for the port "%%PORT%%".

 
-
This is the one-line description for this port:
+    
The package name of this port is "%%PKG%%".

 
-

+    
This is the one-line description for this port:

+    

+
+    

 %%COMMENT%%
-

+    

+    

+
+    
Please read the "description file" for a
+    longer description%%WEBSITE%%.

 
-
Please read the "description file" for a
-longer description.
+    
If needed, you may contact the maintainer of this port or the port mailing-list.

 
-
Go to the top of the ports tree for
-a summary on how to use the ports collection.
+    
%%BUILD_DEPENDS%%

 
-

-%%BUILD_DEPENDS%%
-

-%%RUN_DEPENDS%%
-
-

- Go up one level
-|
- Go to top of ports tree
-
+    
%%RUN_DEPENDS%%

+
+    
Go to the top of the ports tree for
+    a summary on how to use the ports collection.

+    

+
+    
Go up one level | Go to top of ports tree

+  
 
+
Index: Templates/README.top
===================================================================
RCS file: /home/ncvs/ports/Templates/README.top,v
retrieving revision 1.3
diff -u -r1.3 README.top
--- Templates/README.top	2000/08/18 17:18:25	1.3
+++ Templates/README.top	2001/10/20 14:14:14
@@ -1,29 +1,33 @@
+
+
 
- The FreeBSD Ports Collection
-
 The FreeBSD Ports Collection 
  

-
-
-
You are at the top of the ports tree.
-
-

-For information on how to use the ports tree, please look at "The
-Ports Collection" section of the FreeBSD handbook  on your
-own FreeBSD machine or  at the FreeBSD web
-site.
-
-

-
-Also, if you would like to contribute a new port or fix an existing
-one, please refer to the  Porting
-Guidelines section of the most current handbook.
-
Here are the one-line descriptions for each of the directories:
+  
+    The FreeBSD Ports Collection
+  
+
+  
+    
The FreeBSD Ports Collection

+    

+
+    
You are at the top of the ports tree.

+
+    
For information on how to use the ports tree, please look at "The
+    Ports Collection" section of the FreeBSD handbook on your own
+    FreeBSD machine or at the FreeBSD web
+    site.

+
+    
Also, if you would like to contribute a new port or fix an existing
+    one, please refer to the Porting
+    Guidelines section of the most current handbook.

 
-

-
+    
Here are the one-line descriptions for each of the directories:

+    

+
 %%SUBDIR%%
-

-
+

+    

+  
 
>Release-Note:
>Audit-Trail:
>Unformatted:

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-ports" in the body of the message