You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs-cvs@perl.apache.org by st...@apache.org on 2002/04/28 10:34:07 UTC
cvs commit: modperl-docs/admin Changes_template.pod README changes_file.pod style.pod
stas 02/04/28 01:34:07
Modified: admin README changes_file.pod style.pod
Added: admin Changes_template.pod
Log:
extend on changes, add a template for Changes.pod
Submitted by: Per Einar Ellefsen <pe...@skynet.be>
Revision Changes Path
1.3 +6 -0 modperl-docs/admin/README
Index: README
===================================================================
RCS file: /home/cvs/modperl-docs/admin/README,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- README 19 Apr 2002 17:33:09 -0000 1.2
+++ README 28 Apr 2002 08:34:07 -0000 1.3
@@ -8,6 +8,12 @@
doc_template.pod
- A template for you to use for new documents.
+changes_file.pod
+ - explanations regarding the Changes.pod file
+
+Changes_template.pod
+ - A template for the Changes.pod file.
+
maintenance.pod
- Instructions on how to keep the site clean (check HTML
validity and links).
1.2 +30 -1 modperl-docs/admin/changes_file.pod
Index: changes_file.pod
===================================================================
RCS file: /home/cvs/modperl-docs/admin/changes_file.pod,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- changes_file.pod 28 Apr 2002 05:27:19 -0000 1.1
+++ changes_file.pod 28 Apr 2002 08:34:07 -0000 1.2
@@ -43,6 +43,8 @@
it used to add a version number for each milestone, which is very
optional now.
+This file should have the latest changes on the top.
+
=head1 The Scope of Changes.pod
Usually we have a separate I<Changes.pod> file for each sub-set of the
@@ -76,6 +78,33 @@
=head1 Sample Changes.pod
-See <docs/1.0/guide/Changes.pod>.
+See <docs/1.0/guide/Changes.pod> as a good example.
+
+A typical entry looks like this:
+
+ =head1 ???
+
+ * books: Fixed some things and then other things, and then some other
+ things bla bla bla. [John Doe E<lt>john.doe (at) aol.comE<gt>]
+
+ * file: Added some content. [stas]
+
+ * otherfile: updated the "Maintenance" section, adding references to
+ bla bla bla [other person]
+
+ =head1 Sat Nov 12 22:05:23 CET 2002
+
+ * docs::index : moved tutorials to "Other documentation" [stas]
+
+ * performance: minor corrections [thomas]
+
+Please try to keep things correctly aligned here (ie. the first
+characters on each line should be vertically aligned with eachother),
+as this file will most often be viewed as text.
+
+As you can see, we try to collect a number of changes, then timestamp
+the document like a "version".
+
+You can use the I<Changes_template.pod> as a starting point.
=cut
1.7 +7 -23 modperl-docs/admin/style.pod
Index: style.pod
===================================================================
RCS file: /home/cvs/modperl-docs/admin/style.pod,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- style.pod 19 Apr 2002 17:33:09 -0000 1.6
+++ style.pod 28 Apr 2002 08:34:07 -0000 1.7
@@ -156,12 +156,10 @@
L<installation instructions|docs::1.0::guide::install>
-[the second example doesn't work yet, need to be fixed]
+You may also link to the index of a section by using
+
+ L<The Guide|guide::index>
-There are some other linking limitations; e.g. you can't link directly
-to the I<index.html> of a section, and you can't link using relative
-URIs. The latter limitation comes from the perlpodspec and hopefully
-will be improved in the future.
=item *
@@ -319,25 +317,11 @@
=item *
-Changes: In many directories, you will find a file named
-I<Changes.pod>. This file contains the latest changes to a certain
-documentation section, sorted by date (newest first). If you have made
-any changes and sending a patch, it would be nice of you to include
-the updated I<Changes.pod> file together with the patch.
-
-A typical entry would look like this:
-
- =head1 Fri 19 Apr 18:37:00 CET 2002
-
- * Fixed some things and then other things, and then some other
- things bla bla bla. [John Doe E<lt>john.doe (at) aol.comE<gt>]
-
- * Other changes to I<file.pod>, and to I<otherfile.pod>. [stas]
-
-Please try to keep things correctly aligned here (ie. the first
-characters on each line should be vertically aligned with eachother),
-as this file will most often be viewed as text.
+Documenting Important Changes
+If you are posting a patch or a committing a patch, please document
+the important changes that would be of interest to the end user. For
+more info please read I<changes_file.pod> doc.
=back
1.1 modperl-docs/admin/Changes_template.pod
Index: Changes_template.pod
===================================================================
=head1 NAME
Changes
=head1 Description
Refer to this document to learn what changes were made to the
documents since you read them last time.
The most recent changes are listed first.
=head1 ??? (format: Sat Nov 12 20:34:23 CET 2002)
* ... [...]
* ... [...]
=cut
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-cvs-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-cvs-help@perl.apache.org