From 17a0335519638e3f821d38172d104bfad62eb01c Mon Sep 17 00:00:00 2001 From: Evan Martin Date: Sat, 14 May 2011 16:11:41 -0700 Subject: [PATCH] move various doc files out of top-level directory --- .gitignore | 5 ++--- configure.py | 12 +++++++----- doxygen.config => doc/doxygen.config | 4 ++-- manual.asciidoc => doc/manual.asciidoc | 0 .../gen_doxygen_mainpage.sh | 0 5 files changed, 11 insertions(+), 10 deletions(-) rename doxygen.config => doc/doxygen.config (99%) rename manual.asciidoc => doc/manual.asciidoc (100%) rename gen_doxygen_mainpage.sh => src/gen_doxygen_mainpage.sh (100%) diff --git a/.gitignore b/.gitignore index 6f33f81..71f873d 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,5 @@ TAGS /ninja /ninja_test /graph.png -/README.html -/manual.html -/doxygen +/doc/manual.html +/doc/doxygen diff --git a/configure.py b/configure.py index 9353c76..e42a76a 100755 --- a/configure.py +++ b/configure.py @@ -56,6 +56,8 @@ def src(filename): return os.path.join('src', filename) def built(filename): return os.path.join('$builddir', filename) +def doc(filename): + return os.path.join('doc', filename) def cxx(name, **kwargs): return n.build(built(name + '.o'), 'cxx', src(name + '.cc'), **kwargs) @@ -160,11 +162,11 @@ n.newline() n.comment('Generate the manual using asciidoc.') n.rule('asciidoc', - command='asciidoc -a toc $in', + command='asciidoc -a toc $in -o $out', description='ASCIIDOC $in') -n.build('manual.html', 'asciidoc', 'manual.asciidoc') +manual = n.build(doc('manual.html'), 'asciidoc', doc('manual.asciidoc')) n.build('manual', 'phony', - order_only='manual.html') + order_only=manual) n.newline() n.comment('Generate Doxygen.') @@ -172,14 +174,14 @@ n.rule('doxygen', command='doxygen $in', description='DOXYGEN $in') n.variable('doxygen_mainpage_generator', - './gen_doxygen_mainpage.sh') + src('gen_doxygen_mainpage.sh')) n.rule('doxygen_mainpage', command='$doxygen_mainpage_generator $in > $out', description='DOXYGEN_MAINPAGE $out') mainpage = n.build(built('doxygen_mainpage'), 'doxygen_mainpage', ['README', 'HACKING', 'COPYING'], implicit=['$doxygen_mainpage_generator']) -n.build('doxygen', 'doxygen', 'doxygen.config', +n.build('doxygen', 'doxygen', doc('doxygen.config'), implicit=mainpage) n.newline() diff --git a/doxygen.config b/doc/doxygen.config similarity index 99% rename from doxygen.config rename to doc/doxygen.config index 7179dbe..d933021 100644 --- a/doxygen.config +++ b/doc/doxygen.config @@ -30,7 +30,7 @@ PROJECT_NAME = "Ninja" # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. -OUTPUT_DIRECTORY = "doxygen/" +OUTPUT_DIRECTORY = "doc/doxygen/" # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output @@ -1054,7 +1054,7 @@ TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. -GENERATE_TAGFILE = doxygen/html/Ninja.TAGFILE +GENERATE_TAGFILE = doc/doxygen/html/Ninja.TAGFILE # If the ALLEXTERNALS tag is set to YES all external classes will be listed # in the class index. If set to NO only the inherited external classes diff --git a/manual.asciidoc b/doc/manual.asciidoc similarity index 100% rename from manual.asciidoc rename to doc/manual.asciidoc diff --git a/gen_doxygen_mainpage.sh b/src/gen_doxygen_mainpage.sh similarity index 100% rename from gen_doxygen_mainpage.sh rename to src/gen_doxygen_mainpage.sh