From 1dab1836fe17ecdbf750b99832c4d1f789bedcf1 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Wed, 6 May 2020 18:51:42 -0400 Subject: doc abstraction, code & org whitespace, cosmetic --- org/spine_build_scaffold.org | 102 +++++++++++++++++++++---------------------- 1 file changed, 51 insertions(+), 51 deletions(-) (limited to 'org/spine_build_scaffold.org') diff --git a/org/spine_build_scaffold.org b/org/spine_build_scaffold.org index 1da132c..22e156e 100644 --- a/org/spine_build_scaffold.org +++ b/org/spine_build_scaffold.org @@ -17,22 +17,22 @@ [[./org/spine.org][spine.org]] [[./org/][org/]] * makefile :makefile: -** settings [+2] :settings: -*** git version stamp :git:version: +** settings [+2] :settings: +*** git version stamp :git:version: #+BEGIN_SRC makefile :tangle ../makefile PROG_VER_GIT :=$(shell echo `git describe --long --tags | sed -e "s/^[ a-z_-]\+\([0-9.]\+\)/\1/;s/\([^-]*-g\)/r\1/;s/-/./g"`) PROG_VER_DECLARED :=$(shell echo `cat ./views/version.txt | grep --color=never "enum" | sed 's/.\+(\([0-9]\+\),[ \t]\+\([0-9]\+\),[ \t]\+\([0-9]\+\)[ \t]*).\+/\1.\2.\3/g'`) #+END_SRC -*** dub (build tool) :dub: +*** dub (build tool) :dub: #+BEGIN_SRC makefile :tangle ../makefile DUB=dub DUB_FLAGS=-v --force --compiler= #+END_SRC -*** Project Details :project:spine: +*** Project Details :project:spine: #+BEGIN_SRC makefile :tangle ../makefile PRG_NAME=doc-reform @@ -45,7 +45,7 @@ PRG_BINDIR=./bin PRG_DOCDIR=./docs #+END_SRC -*** Emacs Org settings :settings:emacs:org:tangle: +*** Emacs Org settings :settings:emacs:org:tangle: #+BEGIN_SRC makefile :tangle ../makefile EMACSLISP=/usr/share/emacs/site-lisp @@ -129,7 +129,7 @@ data/sisudir/media/text/un_contracts_international_sale_of_goods_convention_1980 data/sisudir/media/text/viral_spiral.david_bollier.sst #+END_SRC -** _make_ commands [+2] :make:commands: +** _make_ commands [+2] :make:commands: - build commands - build @@ -146,9 +146,9 @@ data/sisudir/media/text/viral_spiral.david_bollier.sst - git snapshot - gitsnapshot -*** build commands [+1] :build:compile: -**** _dub_ build rebuild :dub: -***** all compiler builds :all:dmd:gdc:ldc: +*** build commands [+1] :build:compile: +**** _dub_ build rebuild :dub: +***** all compiler builds :all:dmd:gdc:ldc: ****** all builds ******* default @@ -179,26 +179,26 @@ markup_dir_samples: find data/sisudir/media/text -name *.ss[tm] | sort #+END_SRC -******* quick :quick: -******** default :default: +******* quick :quick: +******** default :default: #+BEGIN_SRC makefile :tangle ../makefile all: dmd ldc gdc #+END_SRC -******** version :version: +******** version :version: #+BEGIN_SRC makefile :tangle ../makefile all_ver: dmd_ver ldc_ver gdc_ver #+END_SRC -******** debug :debug: +******** debug :debug: #+BEGIN_SRC makefile :tangle ../makefile all_debug: dmd_debug gdc_debug ldc_debug #+END_SRC -******** _meson_ build :meson: +******** _meson_ build :meson: meson using dub - works & looks pretty clean @@ -216,30 +216,30 @@ meson_project_build_clean: clean skel tangle dub_upgrade meson_build meson: meson_clean_build_dir dub_upgrade meson_build #+END_SRC -******* clean & tangle :clean:tangle: -******** default :default: +******* clean & tangle :clean:tangle: +******** default :default: #+BEGIN_SRC makefile :tangle ../makefile all_clean: clean tangle dmd ldc gdc #+END_SRC -******** version :version: +******** version :version: #+BEGIN_SRC makefile :tangle ../makefile all_ver_clean: clean tangle dmd_ver ldc_ver gdc_ver #+END_SRC -******** debug :debug: +******** debug :debug: #+BEGIN_SRC makefile :tangle ../makefile all_debug_ver: dmd_debug_ver gdc_debug_ver ldc_debug_ver all_debug_clean_ver: clean tangle dmd_debug_ver gdc_debug_ver ldc_debug_ver #+END_SRC -***** individual compiler builds :each: -****** dmd :dmd: -******* quick :quick: -******** default :default: +***** individual compiler builds :each: +****** dmd :dmd: +******* quick :quick: +******** default :default: #+BEGIN_SRC makefile :tangle ../makefile dmd: dub_upgrade @@ -247,14 +247,14 @@ dmd: dub_upgrade notify-send -t 0 'D dmd compiled test release executable ready' 'spine-dmd' #+END_SRC -******** debug :debug: +******** debug :debug: #+BEGIN_SRC makefile :tangle ../makefile dmd_debug: $(DUB) --compiler=dmd --config=dmd -b debug #+END_SRC -******** version :version: +******** version :version: - assumes git tags with program version @@ -266,7 +266,7 @@ dmd_ver: dub_upgrade dmd_clean_ver: clean tangle dmd_ver #+END_SRC -******* clean & tangle :clean:tangle: +******* clean & tangle :clean:tangle: #+BEGIN_SRC makefile :tangle ../makefile dmd_rel: expunge skel tangle @@ -278,9 +278,9 @@ dmd_debug_tangle: tangle $(DUB) --compiler=dmd --config=spine-dmd-debug #+END_SRC -****** gdc :gdc: -******* quick :quick: -******** default :default: +****** gdc :gdc: +******* quick :quick: +******** default :default: #+BEGIN_SRC makefile :tangle ../makefile gdc: dub_upgrade @@ -288,14 +288,14 @@ gdc: dub_upgrade notify-send -t 0 'D gdc compiled test release executable ready' 'spine-gdc' #+END_SRC -******** debug :debug: +******** debug :debug: #+BEGIN_SRC makefile :tangle ../makefile gdc_debug: $(DUB) --compiler=gdc --config=gdc -b debug #+END_SRC -******** version :version: +******** version :version: - assumes git tags with program version @@ -307,7 +307,7 @@ gdc_ver: dub_upgrade gdc_clean_ver: clean tangle gdc_ver #+END_SRC -******* clean & tangle :clean:tangle: +******* clean & tangle :clean:tangle: #+BEGIN_SRC makefile :tangle ../makefile gdc_rel: expunge skel tangle @@ -319,9 +319,9 @@ gdc_debug_tangle: tangle $(DUB) --compiler=gdc --config=spine-gdc-debug #+END_SRC -****** ldc :ldc: -******* quick :quick: -******** default :default: +****** ldc :ldc: +******* quick :quick: +******** default :default: #+BEGIN_SRC makefile :tangle ../makefile ldc: dub_upgrade @@ -329,14 +329,14 @@ ldc: dub_upgrade notify-send -t 0 'D ldc compiled test release executable ready' 'spine-ldc' #+END_SRC -******** debug :debug: +******** debug :debug: #+BEGIN_SRC makefile :tangle ../makefile ldc_debug: $(DUB) --compiler=ldc2 --config=ldc -b debug #+END_SRC -******** version :version: +******** version :version: - assumes git tags with program version @@ -348,7 +348,7 @@ ldc_ver: dub_upgrade ldc_clean_ver: clean tangle ldc_ver #+END_SRC -******* clean & tangle :clean:tangle: +******* clean & tangle :clean:tangle: #+BEGIN_SRC makefile :tangle ../makefile ldc_rel: expunge skel tangle @@ -361,7 +361,7 @@ ldc_debug_tangle: tangle #+END_SRC ***** generic -****** init clean distclean etc. :clean: +****** init clean distclean etc. :clean: #+BEGIN_SRC makefile :tangle ../makefile reinit: clean skel tangle @@ -418,14 +418,14 @@ distclean_and_init: expunge mkdir -p $(PRG_BINDIR); #+END_SRC -****** version :version: +****** version :version: #+BEGIN_SRC makefile :tangle ../makefile ver: echo spine-$(PROG_VER_DECLARED)-tag-$(PROG_VER_GIT) #+END_SRC -****** tangle build rebuild :clean:tangle:build: +****** tangle build rebuild :clean:tangle:build: #+BEGIN_SRC makefile :tangle ../makefile clean_tangle_build: clean tangle build @@ -793,7 +793,7 @@ ldc_testrun_filelist_dir_all: $(SiSU_MARKUP_SAMPLES_DIR) #+END_SRC -*** org babel tangle batch process command :tangle: +*** org babel tangle batch process command :tangle: **** tangle: org babel tangle *.org #+BEGIN_SRC makefile :tangle ../makefile @@ -847,7 +847,7 @@ gitsnapshot: distclean tangle git commit -a #+END_SRC -** phony :phony: +** phony :phony: #+BEGIN_SRC makefile :tangle ../makefile .PHONY : all build rebuild debug release \ @@ -857,7 +857,7 @@ gitsnapshot: distclean tangle * dub.sdl :dub:sdl:config: Every DUB package should contain a [[http://code.dlang.org/package-format?lang=json][dub.json]] (or [[http://code.dlang.org/package-format?lang=sdl][dub.sdl]]) -** header (including dependencies) :header: +** header (including dependencies) :header: #+BEGIN_SRC sh :tangle ../dub.sdl name "spine" @@ -980,8 +980,8 @@ configuration "gdc-version" { } #+END_SRC -*** generic :generic: -**** build (sdp) :release: +*** generic :generic: +**** build (sdp) :release: #+BEGIN_SRC sh configuration "build" { @@ -1197,7 +1197,7 @@ tmp/** #.reggae/** #+END_SRC -* sh script to batch process _emacs org babel tangle_ :shell_script:tangle: +* sh script to batch process _emacs org babel tangle_ :shell_script:tangle: [[http://orgmode.org/manual/Batch-execution.html]] creates a shell batch script called "tangle", that will tangle (emacs org babel tangle) org files in ./org/ to create .d source files in ./src/doc_reform/ @@ -1531,20 +1531,20 @@ time make tangle ldc time make ldc_testrun_find_pod_epub #+END_SRC -** dub zfunc :zfunc: -*** ,dubdmd :dmd: +** dub zfunc :zfunc: +*** ,dubdmd :dmd: #+BEGIN_SRC sh :tangle no time dub --compiler=dmd -v --force #+END_SRC -*** ,dubldc :ldc: +*** ,dubldc :ldc: #+BEGIN_SRC sh :tangle no time dub --compiler=ldc2 -v --force #+END_SRC -*** ,dubgdc :gdc: +*** ,dubgdc :gdc: #+BEGIN_SRC sh :tangle no time dub --compiler=gdc -v --force @@ -1605,7 +1605,7 @@ time make ldc_testrun_filelist_dir_pod [[http://wiki.dlang.org/Compilers][D Compilers wiki https://wiki.dlang.org/Compilers]] [[http://dlang.org/download.html][D Compilers download http://dlang.org/download.html]] -*** dub :dub: +*** dub :dub: https://github.com/dlang/dub/ http://code.dlang.org/getting_started -- cgit v1.2.3