summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorEli Schwartz <eschwartz@archlinux.org>2018-05-03 06:10:21 +0200
committerAllan McRae <allan@archlinux.org>2018-05-14 01:59:17 +0200
commit076b6184de2b20e9b26225d93f6f3a7030504109 (patch)
treeca0e375b9fd89d6b6ce40026b732985c4b335841 /doc
parent860e4c4943ad062bd0eff99f28e7d64804b3c08e (diff)
downloadpacman-076b6184de2b20e9b26225d93f6f3a7030504109.tar.gz
pacman-076b6184de2b20e9b26225d93f6f3a7030504109.tar.xz
Ensure better text editor automatic filetype detection
Since we no longer use vim-specific modelines, use the .asciidoc file extension which is, well, reserved for asciidoc formatted files. This should presumably work everywhere without needing editor-specific workarounds and configuration. Also add a shebang to makepkg.conf to indicate it contains bash content. Signed-off-by: Eli Schwartz <eschwartz@archlinux.org> Signed-off-by: Allan McRae <allan@archlinux.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/BUILDINFO.5.asciidoc (renamed from doc/BUILDINFO.5.txt)2
-rw-r--r--doc/Makefile.am68
-rw-r--r--doc/PKGBUILD.5.asciidoc (renamed from doc/PKGBUILD.5.txt)2
-rw-r--r--doc/alpm-hooks.5.asciidoc (renamed from doc/alpm-hooks.5.txt)2
-rw-r--r--doc/footer.asciidoc (renamed from doc/footer.txt)0
-rw-r--r--doc/index.asciidoc (renamed from doc/index.txt)0
-rw-r--r--doc/libalpm.3.asciidoc (renamed from doc/libalpm.3.txt)2
-rw-r--r--doc/makepkg-template.1.asciidoc (renamed from doc/makepkg-template.1.txt)2
-rw-r--r--doc/makepkg.8.asciidoc (renamed from doc/makepkg.8.txt)2
-rw-r--r--doc/makepkg.conf.5.asciidoc (renamed from doc/makepkg.conf.5.txt)2
-rw-r--r--doc/pacman-key.8.asciidoc (renamed from doc/pacman-key.8.txt)2
-rw-r--r--doc/pacman.8.asciidoc (renamed from doc/pacman.8.txt)2
-rw-r--r--doc/pacman.conf.5.asciidoc (renamed from doc/pacman.conf.5.txt)2
-rw-r--r--doc/pkgdelta.8.asciidoc (renamed from doc/pkgdelta.8.txt)2
-rw-r--r--doc/repo-add.8.asciidoc (renamed from doc/repo-add.8.txt)2
-rw-r--r--doc/submitting-patches.asciidoc (renamed from doc/submitting-patches.txt)0
-rw-r--r--doc/translation-help.asciidoc (renamed from doc/translation-help.txt)0
-rw-r--r--doc/vercmp.8.asciidoc (renamed from doc/vercmp.8.txt)2
18 files changed, 47 insertions, 47 deletions
diff --git a/doc/BUILDINFO.5.txt b/doc/BUILDINFO.5.asciidoc
index a7e6b2e4..3db1e12f 100644
--- a/doc/BUILDINFO.5.txt
+++ b/doc/BUILDINFO.5.asciidoc
@@ -67,4 +67,4 @@ See Also
--------
linkman:makepkg[8], linkman:pacman[8], linkman:makepkg.conf[5]
-include::footer.txt[]
+include::footer.asciidoc[]
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 3eff9194..8dec4ab1 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -47,24 +47,24 @@ HTML_DOCS = \
EXTRA_DIST = \
asciidoc.conf \
asciidoc-override.css \
- alpm-hooks.5.txt \
- pacman.8.txt \
- makepkg.8.txt \
- makepkg-template.1.txt \
- repo-add.8.txt \
- vercmp.8.txt \
- pkgdelta.8.txt \
- pacman-key.8.txt \
- PKGBUILD.5.txt \
+ alpm-hooks.5.asciidoc \
+ pacman.8.asciidoc \
+ makepkg.8.asciidoc \
+ makepkg-template.1.asciidoc \
+ repo-add.8.asciidoc \
+ vercmp.8.asciidoc \
+ pkgdelta.8.asciidoc \
+ pacman-key.8.asciidoc \
+ PKGBUILD.5.asciidoc \
PKGBUILD-example.txt \
- makepkg.conf.5.txt \
- pacman.conf.5.txt \
- BUILDINFO.5.txt \
- libalpm.3.txt \
- footer.txt \
- index.txt \
- submitting-patches.txt \
- translation-help.txt \
+ makepkg.conf.5.asciidoc \
+ pacman.conf.5.asciidoc \
+ BUILDINFO.5.asciidoc \
+ libalpm.3.asciidoc \
+ footer.asciidoc \
+ index.asciidoc \
+ submitting-patches.asciidoc \
+ translation-help.asciidoc \
Doxyfile \
$(ASCIIDOC_MANS) \
$(DOXYGEN_MANS)
@@ -130,11 +130,11 @@ A2X_OPTS = \
--xsltproc-opts='-param man.endnotes.list.enabled 0 -param man.endnotes.are.numbered 0'
# These rules are due to the includes and files of the asciidoc text
-$(ASCIIDOC_MANS): asciidoc.conf footer.txt Makefile.am
- $(AM_V_GEN)a2x $(A2X_OPTS) --asciidoc-opts="$(ASCIIDOC_OPTS) --out-file=./$@.xml" $(srcdir)/$@.txt
+$(ASCIIDOC_MANS): asciidoc.conf footer.asciidoc Makefile.am
+ $(AM_V_GEN)a2x $(A2X_OPTS) --asciidoc-opts="$(ASCIIDOC_OPTS) --out-file=./$@.xml" $(srcdir)/$@.asciidoc
-%.html: %.txt
- $(AM_V_GEN)asciidoc $(ASCIIDOC_OPTS) -o - $*.txt | \
+%.html: %.asciidoc
+ $(AM_V_GEN)asciidoc $(ASCIIDOC_OPTS) -o - $*.asciidoc | \
sed -e 's/\r$$//' > $@
HACKING.html: ../HACKING
@@ -142,7 +142,7 @@ HACKING.html: ../HACKING
sed -e 's/\r$$//' > $@
# Customizations for certain HTML docs
-$(HTML_MANPAGES): asciidoc.conf footer.txt Makefile.am
+$(HTML_MANPAGES): asciidoc.conf footer.asciidoc Makefile.am
$(HTML_OTHER): asciidoc.conf Makefile.am
%.html: ASCIIDOC_OPTS += -a linkcss -a toc -a icons -a max-width=960px -a stylesheet=asciidoc-override.css
%.8.html: ASCIIDOC_OPTS += -d manpage
@@ -150,18 +150,18 @@ $(HTML_OTHER): asciidoc.conf Makefile.am
%.3.html: ASCIIDOC_OPTS += -d manpage
# Dependency rules
-alpm-hooks.5 alpm-hooks.5.html: alpm-hooks.5.txt
-pacman.8 pacman.8.html: pacman.8.txt
-makepkg.8 makepkg.8.html: makepkg.8.txt
-makepkg-template.1 makepkg-template.1.html: makepkg-template.1.txt
-repo-add.8 repo-add.8.html: repo-add.8.txt
-vercmp.8 vercmp.8.html: vercmp.8.txt
-pkgdelta.8 pkgdelta.8.html: pkgdelta.8.txt
-pacman-key.8 pacman-key.8.html: pacman-key.8.txt
-PKGBUILD.5 PKGBUILD.5.html: PKGBUILD.5.txt PKGBUILD-example.txt
-makepkg.conf.5 makepkg.conf.5.html: makepkg.conf.5.txt
-pacman.conf.5 pacman.conf.5.html: pacman.conf.5.txt
-libalpm.3 libalpm.3.html: libalpm.3.txt
+alpm-hooks.5 alpm-hooks.5.html: alpm-hooks.5.asciidoc
+pacman.8 pacman.8.html: pacman.8.asciidoc
+makepkg.8 makepkg.8.html: makepkg.8.asciidoc
+makepkg-template.1 makepkg-template.1.html: makepkg-template.1.asciidoc
+repo-add.8 repo-add.8.html: repo-add.8.asciidoc
+vercmp.8 vercmp.8.html: vercmp.8.asciidoc
+pkgdelta.8 pkgdelta.8.html: pkgdelta.8.asciidoc
+pacman-key.8 pacman-key.8.html: pacman-key.8.asciidoc
+PKGBUILD.5 PKGBUILD.5.html: PKGBUILD.5.asciidoc PKGBUILD-example.txt
+makepkg.conf.5 makepkg.conf.5.html: makepkg.conf.5.asciidoc
+pacman.conf.5 pacman.conf.5.html: pacman.conf.5.asciidoc
+libalpm.3 libalpm.3.html: libalpm.3.asciidoc
# this one is just a symlink
repo-remove.8: repo-add.8
$(RM) repo-remove.8
diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.asciidoc
index 795dde45..9634bd15 100644
--- a/doc/PKGBUILD.5.txt
+++ b/doc/PKGBUILD.5.asciidoc
@@ -522,4 +522,4 @@ See Also
--------
linkman:makepkg[8], linkman:pacman[8], linkman:makepkg.conf[5]
-include::footer.txt[]
+include::footer.asciidoc[]
diff --git a/doc/alpm-hooks.5.txt b/doc/alpm-hooks.5.asciidoc
index eb56054e..1d19f96e 100644
--- a/doc/alpm-hooks.5.txt
+++ b/doc/alpm-hooks.5.asciidoc
@@ -125,4 +125,4 @@ or not they were actually present on the file system before package removal.
PostTransaction hooks will *not* run if the transaction fails to complete for
any reason.
-include::footer.txt[]
+include::footer.asciidoc[]
diff --git a/doc/footer.txt b/doc/footer.asciidoc
index 5812aa72..5812aa72 100644
--- a/doc/footer.txt
+++ b/doc/footer.asciidoc
diff --git a/doc/index.txt b/doc/index.asciidoc
index 48510830..48510830 100644
--- a/doc/index.txt
+++ b/doc/index.asciidoc
diff --git a/doc/libalpm.3.txt b/doc/libalpm.3.asciidoc
index e75fb880..79ea5409 100644
--- a/doc/libalpm.3.txt
+++ b/doc/libalpm.3.asciidoc
@@ -34,4 +34,4 @@ See Also
linkman:alpm-hooks[5], linkman:makepkg[8], linkman:pacman[8],
linkman:pacman.conf[5]
-include::footer.txt[]
+include::footer.asciidoc[]
diff --git a/doc/makepkg-template.1.txt b/doc/makepkg-template.1.asciidoc
index fcb19b07..1cf39fb2 100644
--- a/doc/makepkg-template.1.txt
+++ b/doc/makepkg-template.1.asciidoc
@@ -115,4 +115,4 @@ See Also
--------
linkman:makepkg[8], linkman:PKGBUILD[5]
-include::footer.txt[]
+include::footer.asciidoc[]
diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.asciidoc
index 58e9b27a..b15e3a67 100644
--- a/doc/makepkg.8.txt
+++ b/doc/makepkg.8.asciidoc
@@ -346,4 +346,4 @@ See Also
--------
linkman:makepkg.conf[5], linkman:PKGBUILD[5], linkman:pacman[8]
-include::footer.txt[]
+include::footer.asciidoc[]
diff --git a/doc/makepkg.conf.5.txt b/doc/makepkg.conf.5.asciidoc
index 27ca3d9d..3b596a91 100644
--- a/doc/makepkg.conf.5.txt
+++ b/doc/makepkg.conf.5.asciidoc
@@ -266,4 +266,4 @@ See Also
--------
linkman:makepkg[8], linkman:pacman[8], linkman:PKGBUILD[5]
-include::footer.txt[]
+include::footer.asciidoc[]
diff --git a/doc/pacman-key.8.txt b/doc/pacman-key.8.asciidoc
index 0b46f919..f0b5ac08 100644
--- a/doc/pacman-key.8.txt
+++ b/doc/pacman-key.8.asciidoc
@@ -142,4 +142,4 @@ See Also
--------
linkman:pacman[8], linkman:pacman.conf[5]
-include::footer.txt[]
+include::footer.asciidoc[]
diff --git a/doc/pacman.8.txt b/doc/pacman.8.asciidoc
index ebe16e61..b6f4dd76 100644
--- a/doc/pacman.8.txt
+++ b/doc/pacman.8.asciidoc
@@ -565,4 +565,4 @@ See Also
linkman:alpm-hooks[5], linkman:libalpm[3], linkman:makepkg[8],
linkman:pacman.conf[5]
-include::footer.txt[]
+include::footer.asciidoc[]
diff --git a/doc/pacman.conf.5.txt b/doc/pacman.conf.5.asciidoc
index db8fe740..e5fffecf 100644
--- a/doc/pacman.conf.5.txt
+++ b/doc/pacman.conf.5.asciidoc
@@ -368,4 +368,4 @@ See Also
--------
linkman:pacman[8], linkman:libalpm[3]
-include::footer.txt[]
+include::footer.asciidoc[]
diff --git a/doc/pkgdelta.8.txt b/doc/pkgdelta.8.asciidoc
index 6d93a67a..412e607e 100644
--- a/doc/pkgdelta.8.txt
+++ b/doc/pkgdelta.8.asciidoc
@@ -50,4 +50,4 @@ See Also
--------
linkman:pacman[8], linkman:xdelta3[1]
-include::footer.txt[]
+include::footer.asciidoc[]
diff --git a/doc/repo-add.8.txt b/doc/repo-add.8.asciidoc
index 4c6d8d5a..945fff75 100644
--- a/doc/repo-add.8.txt
+++ b/doc/repo-add.8.asciidoc
@@ -91,4 +91,4 @@ See Also
--------
linkman:makepkg[8], linkman:pacman[8], linkman:pkgdelta[8]
-include::footer.txt[]
+include::footer.asciidoc[]
diff --git a/doc/submitting-patches.txt b/doc/submitting-patches.asciidoc
index 73c7487d..73c7487d 100644
--- a/doc/submitting-patches.txt
+++ b/doc/submitting-patches.asciidoc
diff --git a/doc/translation-help.txt b/doc/translation-help.asciidoc
index 67117bcc..67117bcc 100644
--- a/doc/translation-help.txt
+++ b/doc/translation-help.asciidoc
diff --git a/doc/vercmp.8.txt b/doc/vercmp.8.asciidoc
index f8328a6b..88021674 100644
--- a/doc/vercmp.8.txt
+++ b/doc/vercmp.8.asciidoc
@@ -69,4 +69,4 @@ See Also
--------
linkman:pacman[8], linkman:makepkg[8], linkman:libalpm[3]
-include::footer.txt[]
+include::footer.asciidoc[]