Skip to content

Commit b61f4d8

Browse files
committed
README: Add executable documentation
1 parent 00fbf7b commit b61f4d8

File tree

2 files changed

+21
-11
lines changed

2 files changed

+21
-11
lines changed

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,4 @@
44
\#*\#
55
/*-autoloads.el
66
/*-pkg.el
7-
/gnuplot-*.*.*/
8-
/gpelcard.ps
7+
/gnuplot-*/

README.org

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -136,12 +136,23 @@ until this issue is fixed upstream.
136136
* Maintenance of generated files
137137

138138
The files ~gnuplot.texi~ and ~gnuplot-eldoc.el~ are generated from the Gnuplot
139-
source. The source can be pulled downloaded from here:
140-
141-
- https://packages.debian.org/unstable/gnuplot
142-
- http://deb.debian.org/debian/pool/main/g/gnuplot/gnuplot_6.0.2+dfsg1.orig.tar.xz
143-
144-
1. Run ~emacs -batch -l doc2texi.el -f d2t-doc-to-texi~ inside the ~gnuplot-*/docs/~
145-
source directory.
146-
2. Run ~makeinfo --no-split gnuplot.texi~ and ensure that it compiles cleanly.
147-
3. Copy ~gnuplot-eldoc.el~ and ~gnuplot.texi~ to the package source directory.
139+
source, which can be obtained from https://packages.debian.org/unstable/gnuplot.
140+
141+
#+begin_src bash
142+
# Download and extract the Gnuplot source
143+
[ -e gnuplot-source.tar.xz ] || curl -o gnuplot-source.tar.xz http://deb.debian.org/debian/pool/main/g/gnuplot/gnuplot_6.0.2+dfsg1.orig.tar.xz
144+
rm -rf gnuplot-source/
145+
mkdir gnuplot-source
146+
tar --strip-components=1 -C gnuplot-source -xf gnuplot-source.tar.xz
147+
148+
# Run doc2texi.el inside the gnuplot-source/docs directory
149+
cp doc2texi.el gnuplot-source/docs
150+
cd gnuplot-source/docs
151+
emacs -batch -l doc2texi.el -f d2t-doc-to-texi
152+
153+
# Make sure that the info file compiles cleanly
154+
makeinfo --no-split gnuplot.texi
155+
156+
# Copy the updated gnuplot-eldoc.el and gnuplot.texi to the package directory
157+
cp gnuplot.texi gnuplot-eldoc.el ../..
158+
#+end_src

0 commit comments

Comments
 (0)