[Piuparts-commits] [piuparts] 02/02: Rename README_1st to README.
Holger Levsen
holger at moszumanska.debian.org
Sun May 25 17:40:39 UTC 2014
This is an automated email from the git hooks/post-receive script.
holger pushed a commit to branch develop
in repository piuparts.
commit 441dc14c81258273586cc2d1a2f5dbb8cf6323fd
Author: Holger Levsen <holger at layer-acht.org>
Date: Sun May 25 17:14:47 2014 +0200
Rename README_1st to README.
---
Makefile | 8 ++++----
README_1st.txt => README.txt | 8 ++++----
TODO | 7 ++-----
debian/changelog | 2 +-
debian/piuparts.docs | 4 ++--
htdocs/index.tpl | 2 +-
piuparts-report.py | 2 +-
7 files changed, 15 insertions(+), 18 deletions(-)
diff --git a/Makefile b/Makefile
index 79b845b..219cd23 100644
--- a/Makefile
+++ b/Makefile
@@ -23,7 +23,7 @@ endif
SCRIPTS_TEMPLATES = $(wildcard *.in master-bin/*.in slave-bin/*.in conf/*.in)
SCRIPTS_PYTHON_BINARY = $(wildcard *.py master-bin/*.py slave-bin/*.py)
SCRIPTS_GENERATED = $(SCRIPTS_TEMPLATES:.in=) $(SCRIPTS_PYTHON_BINARY:.py=)
-DOCS_GENERATED = piuparts.1 piuparts.1.html piuparts_slave_run.8 piuparts_slave_join.8 README_1st.html README_server.html
+DOCS_GENERATED = piuparts.1 piuparts.1.html piuparts_slave_run.8 piuparts_slave_join.8 README.html README_server.html
define placeholder_substitution
sed -r \
@@ -54,8 +54,8 @@ build-stamp: $(SCRIPTS_GENERATED) $(DOCS_GENERATED) Makefile
build-doc: $(DOCS_GENERATED)
-README_1st.html: README_1st.txt
- a2x --copy -a toc -a toclevels=3 -f xhtml -r /etc/asciidoc/ README_1st.txt
+README.html: README.txt
+ a2x --copy -a toc -a toclevels=3 -f xhtml -r /etc/asciidoc/ README.txt
README_server.html: README_server.txt
a2x --copy -a toc -a toclevels=3 -f xhtml -r /etc/asciidoc/ README_server.txt
@@ -74,7 +74,7 @@ piuparts.1.html: piuparts.1.txt
install-doc: build-stamp
install -d $(DESTDIR)$(docdir)/
- install -m 0644 README_1st.txt README_1st.html README_server.txt README_server.html docbook-xsl.css $(DESTDIR)$(docdir)/
+ install -m 0644 README.txt README.html README_server.txt README_server.html docbook-xsl.css $(DESTDIR)$(docdir)/
install -d $(DESTDIR)$(man1dir)
install -m 0644 piuparts.1 $(DESTDIR)$(man1dir)/
install -d $(DESTDIR)$(man8dir)
diff --git a/README_1st.txt b/README.txt
similarity index 98%
rename from README_1st.txt
rename to README.txt
index ad82590..dd32b70 100644
--- a/README_1st.txt
+++ b/README.txt
@@ -1,10 +1,10 @@
-piuparts README_1st
+piuparts README
-------------------
Author: Lars Wirzenius
Email: <liw at iki.fi>
-After reading this README_1st you probably also want to have a look
+After reading this README you probably also want to have a look
at the piuparts manpage, to learn about the available options.
But read this document first!
@@ -67,6 +67,8 @@ unstable and then upgrade to the local package use this:
=== Some tips
+piuparts also has a manpage, where all available options are explained.
+
If you use piuparts on a regular basis, waiting for it to create
a chroot every time takes too much time, even if you are using a
local mirror or a caching tool such as approx.
@@ -106,8 +108,6 @@ pbuilder. You can save a tarball for later use with the '-s'
to only have to maintain one tarball. Read the piuparts manpage
about the '-p', '-b' and '-s' options
-piuparts has a manpage too.
-
=== Piuparts tests
By default, piuparts does two tests:
diff --git a/TODO b/TODO
index 5bff9dc..05dd6c7 100644
--- a/TODO
+++ b/TODO
@@ -8,11 +8,8 @@ wishlist!
for 0.5x:
- Documentation related:
- - check that making piuparts-master + piuparts-slave packages work is
- documented properly.
- - examples are duplicated in piuparts.1.txt and README_1st.txt - only keep
- one copy or life with it? README_1st is also more of a README than a
- README_1st...
+ - examples are duplicated in piuparts.1.txt and README.txt - only keep
+ one copy or life with it?
- more stats and graphs:
- new section stats page:
diff --git a/debian/changelog b/debian/changelog
index 505842c..cb8f87e 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -28,7 +28,7 @@ piuparts (0.59) UNRELEASED; urgency=low
maybe recommend the master package, but definitly not pre-depend on it,
which would be a requirement to make this work. So document this
instead.
- * Updates various pieces of documentation.
+ * Updates various pieces of documentation, rename README_1st to README.
-- Holger Levsen <holger at debian.org> Thu, 01 May 2014 00:42:23 +0200
diff --git a/debian/piuparts.docs b/debian/piuparts.docs
index 6e6d8c4..2bf155e 100644
--- a/debian/piuparts.docs
+++ b/debian/piuparts.docs
@@ -1,4 +1,4 @@
-README_1st.txt
-README_1st.html
+README.txt
+README.html
piuparts.1.html
docbook-xsl.css
diff --git a/htdocs/index.tpl b/htdocs/index.tpl
index 511b3ee..a008b83 100644
--- a/htdocs/index.tpl
+++ b/htdocs/index.tpl
@@ -22,7 +22,7 @@
</tr>
<tr class="normalrow">
<td class="contentcell2">
- A quick introduction is available in the <a href="/doc/README_1st.html" target="_blank">piuparts README_1st</a>, and all the options are listed on the <a href="/doc/piuparts.1.html" target="_blank">piuparts manpage</a>.
+ A quick introduction is available in the <a href="/doc/README.html" target="_blank">piuparts README</a>, and all the options are listed on the <a href="/doc/piuparts.1.html" target="_blank">piuparts manpage</a>.
</td>
</tr>
<tr class="normalrow">
diff --git a/piuparts-report.py b/piuparts-report.py
index 5bb2977..554a56d 100644
--- a/piuparts-report.py
+++ b/piuparts-report.py
@@ -139,7 +139,7 @@ HTML_HEADER = """<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
</tr>
<tr class="normalrow">
<td class="contentcell">
- <a href="$doc_root/doc/README_1st.html" target="_blank">README_1st</a>
+ <a href="$doc_root/doc/README.html" target="_blank">README</a>
</td>
</tr>
<tr class="normalrow">
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/piuparts/piuparts.git
More information about the Piuparts-commits
mailing list