aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTrygve Laugstøl <trygvis@inamo.no>2013-10-26 19:31:49 +0200
committerTrygve Laugstøl <trygvis@inamo.no>2013-10-26 19:31:49 +0200
commit91052dfc0d9e23b2baf499f6c5aab21b1544a236 (patch)
tree7906e76ef0cde2f27c0b3a6003ee751529df7f91 /docs
parent0a48ad9f4a9382627f270065c6f756351474b7a8 (diff)
downloadapp.sh-91052dfc0d9e23b2baf499f6c5aab21b1544a236.tar.gz
app.sh-91052dfc0d9e23b2baf499f6c5aab21b1544a236.tar.bz2
app.sh-91052dfc0d9e23b2baf499f6c5aab21b1544a236.tar.xz
app.sh-91052dfc0d9e23b2baf499f6c5aab21b1544a236.zip
o Adding a man page on internals.
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile17
-rw-r--r--docs/app-cat-conf.txt8
-rw-r--r--docs/app.txt27
-rw-r--r--docs/appinternals.txt33
-rw-r--r--docs/asciidoc.conf4
5 files changed, 58 insertions, 31 deletions
diff --git a/docs/Makefile b/docs/Makefile
index 2a62f18..f340323 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,6 +1,8 @@
TXT=$(wildcard *.txt)
+# Expand target section from heading of each page
+MAN=$(shell ls *.txt|xargs -n 1 head -n 1|sed "s,\(.*\)(\([0-9]\)),\1.\2,")
HTML=$(patsubst %.txt,%.html,$(TXT))
-MAN=$(patsubst %.txt,%.1,$(TXT))
+
all: $(HTML) $(MAN)
%.html: %.txt
@@ -8,8 +10,15 @@ all: $(HTML) $(MAN)
@asciidoc -f asciidoc.conf --backend=html5 $<
%.1: %.txt
- @echo a2x $<
- @a2x --format manpage $<
+ $(call man,$<)
+
+%.7: %.txt
+ $(call man,$<)
+
+define man
+ @echo a2x $(1)
+ @a2x --format manpage $(1)
+endef
clean:
- rm -rf $(wildcard *.html) $(wildcard *.1)
+ rm -rf $(wildcard *.html) $(wildcard *.1) $(wildcard *.7)
diff --git a/docs/app-cat-conf.txt b/docs/app-cat-conf.txt
index ec2c4f9..0b4f83a 100644
--- a/docs/app-cat-conf.txt
+++ b/docs/app-cat-conf.txt
@@ -45,6 +45,14 @@ LOCATIONS AND DEFAULT FILES
* '.app/config'
+TODOs
+-----
+
+Support comments::
+ 1) ignore comments (lines that start with #), 2) add a flag (-C) to
+ include comments in the output but still filter the lines. (2) is
+ required for app-conf set to work. (1) can be done first.
+
SEE ALSO
--------
diff --git a/docs/app.txt b/docs/app.txt
index fb77174..c0d92f6 100644
--- a/docs/app.txt
+++ b/docs/app.txt
@@ -55,30 +55,6 @@ CHANGING VERSION OF AN APPLICATION
`app-sync-version` will first run the resolver to resolve the version
and if that has changed, it will download and install the new version.
-INTERNALS
----------
-
-Concepts:
-
-resolver::
- Something that takes a version and resolves it to a specific
- version. Makes it possible to depend on a development version
- which is resolved later on.
-
-Configuration properties:
-
-`app.version`::
- The unresolved version of the application. Configured when the
- application is installed.
-
-`app.resolved_version`::
- The resolved version of the application. Is updated by the
- resolved configured for the project.
-
-`app.installed_version`::
- The installed version of the application. Is updated by
- `app-set-version`.
-
TODOs
-----
@@ -92,6 +68,7 @@ TODOs
SEE ALSO
--------
-linkman:app-conf[1]
+linkman:app-conf[1],
+linkman:appinternals[1],
// vim: set ft=asciidoc:
diff --git a/docs/appinternals.txt b/docs/appinternals.txt
new file mode 100644
index 0000000..743cb03
--- /dev/null
+++ b/docs/appinternals.txt
@@ -0,0 +1,33 @@
+appinternals(7)
+===============
+
+NAME
+----
+appinternals - Appsh internals
+
+DESCRIPTION
+-----------
+
+Concepts:
+
+resolver::
+ Something that takes a version and resolves it to a specific
+ version. Makes it possible to depend on a development version
+ which is resolved later on.
+
+Configuration properties:
+
+`app.version`::
+ The unresolved version of the application. Configured when the
+ application is installed.
+
+`app.resolved_version`::
+ The resolved version of the application. Is updated by the
+ resolved configured for the project.
+
+`app.installed_version`::
+ The installed version of the application. Is updated by
+ `app-set-version`.
+
+
+// vim: set ft=asciidoc:
diff --git a/docs/asciidoc.conf b/docs/asciidoc.conf
index 8622db4..724524a 100644
--- a/docs/asciidoc.conf
+++ b/docs/asciidoc.conf
@@ -11,8 +11,8 @@ endif::backend-docbook[]
ifdef::backend-html5[]
-#[attributes]
-#relative-ext=.html
+[attributes]
+relative-ext=.html
[linkman-inlinemacro]
<a href="{target}.html">{target}{0?({0})}</a>