From 3af3b7b1656e73b3ea8ec00038aedef502fc3107 Mon Sep 17 00:00:00 2001 From: Gary Oberbrunner Date: Sat, 26 Apr 2014 16:43:54 -0400 Subject: Updated author and copyright info. Also cleaned up a couple of doc typos. --- doc/man/scons.xml | 24 ++++++++++++------------ doc/python10/main.xml | 8 ++++---- doc/user/main.xml | 2 +- 3 files changed, 17 insertions(+), 17 deletions(-) (limited to 'doc') diff --git a/doc/man/scons.xml b/doc/man/scons.xml index d726796e..10d25097 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -52,19 +52,19 @@ Knight - Steven Knight + Steven Knight and the SCons Development Team - 2004, 2005, 2006, 2007, 2008, 2009, 2010 + 2004 - 2014 - 2004, 2005, 2006, 2007, 2008, 2009, 2010 - Steven Knight + 2004 - 2014 + The SCons Foundation version &buildversion; - + - + SCons &buildversion; @@ -4936,7 +4936,7 @@ multi-stage builder. single_source Specifies that this builder expects exactly one source file per call. Giving -more than one source file without target files results in implicitely calling +more than one source file without target files results in implicitly calling the builder multiple times (once for each source given). Giving multiple source files together with target files results in a UserError exception. @@ -5118,7 +5118,7 @@ function will turn its action keyword argument into an appropriate internal Action object. -You can also explicity create Action objects +You can also explicitly create Action objects using the Action() global function, @@ -6125,7 +6125,7 @@ So in the following case: env['COND'] = 0 env.Command('foo.out', 'foo.in', - + '''echo ${COND==1 and 'FOO' or 'BAR'} > $TARGET''') the command executed will be either @@ -7095,9 +7095,9 @@ source code. AUTHORS -Steven Knight <knight@baldmt.com> - -Anthony Roach <aroach@electriceyeball.com> +Originally: Steven Knight <knight@baldmt.com> and Anthony Roach <aroach@electriceyeball.com>
+Since 2010: The SCons Development Team <scons-dev@scons.org> + diff --git a/doc/python10/main.xml b/doc/python10/main.xml index 60938527..a7732dab 100644 --- a/doc/python10/main.xml +++ b/doc/python10/main.xml @@ -10,7 +10,7 @@
- + - + SCons Design and Implementation @@ -46,8 +46,8 @@ 2001 - 2002 - Steven Knight + 2014 + The SCons Foundation 2002 diff --git a/doc/user/main.xml b/doc/user/main.xml index ae515fa3..a1657776 100644 --- a/doc/user/main.xml +++ b/doc/user/main.xml @@ -72,7 +72,7 @@ Knight - Steven Knight + Steven Knight and the SCons Development Team 2004 - 2014 -- cgit v1.2.1 From b9d048cbe27af7bc72e51afb68d22f9c84491ef1 Mon Sep 17 00:00:00 2001 From: Dirk Baechle Date: Tue, 27 May 2014 23:39:42 +0200 Subject: - improved dependency handling for bootstrap process: the "doc" folder is now correctly linked to its counterpart in "build/doc" --- doc/SConscript | 80 ++++++++++++++++++++++++++++++++++------------------------ 1 file changed, 47 insertions(+), 33 deletions(-) (limited to 'doc') diff --git a/doc/SConscript b/doc/SConscript index d5cd01c9..b82d63bc 100644 --- a/doc/SConscript +++ b/doc/SConscript @@ -246,18 +246,32 @@ else: copy_dbfiles(env, toolpath, [], 'zip.py') # - # Each document will live in its own subdirectory. List them here - # by their subfolder names. Note, how the specifiers for each subdir - # have nothing to do with which formats get created...but which - # of the outputs get installed to the build folder and added to - # the different source and binary packages in the end. - # - docs = {'design' : ['chunked','pdf'], - #'python10' : ['chunked','html','pdf'], - 'reference' : ['chunked','html','pdf'], - #'developer' : ['chunked','html','pdf'], - 'user' : ['chunked','html','pdf','epub','text'], - 'man' : ['man','epub','text'] + # Each document will live in its own subdirectory "build/doc/xxx". + # List them here by their subfolder names. Note, how the specifiers + # for each subdir (=DOCTARGETS) have nothing to do with which + # formats get created...but which of the outputs get installed + # to the build folder and added to the different source and binary + # packages in the end. + # In addition to the list of target formats (DOCTARGETS), we also + # store some dependency information in this dict. The DOCDEPENDS + # list contains all files from each local "MANIFEST", after + # installing/copying them to the build directory. It basically + # links the original sources to the respective build folder, + # such that a simple 'python bootstrap.py' rebuilds the + # documentation when a file, like 'doc/user/depends.xml' + # for example, changes. + # Finally, in DOCNODES we store the created PDF and HTML files, + # such that we can then install them in the proper places for + # getting picked up by the archiving/packaging stages. + DOCTARGETS = 0 + DOCDEPENDS = 1 + DOCNODES = 2 + docs = {'design' : (['chunked','pdf'], [], []), + #'python10' : (['chunked','html','pdf'], [], []), + 'reference' : (['chunked','html','pdf'], [], []), + #'developer' : (['chunked','html','pdf'], [], []), + 'user' : (['chunked','html','pdf','epub','text'], [], []), + 'man' : (['man','epub','text'], [], []) } # The names of the target files for the MAN pages @@ -306,18 +320,18 @@ else: else: target_dir = os.path.join(build, doc) if ext in ['.fig', '.jpg', '.svg']: - buildsuite.extend(env.Command(build_s, doc_s, - Copy("$TARGET", "$SOURCE"))) + docs[doc][DOCDEPENDS].extend(env.Command(build_s, doc_s, + Copy("$TARGET", "$SOURCE"))) else: - revaction([env.File(build_s)], - [env.File(doc_s)], env) + btarget = env.File(build_s) + docs[doc][DOCDEPENDS].append(btarget) + revaction([btarget], [env.File(doc_s)], env) # # For each document, build the document itself in HTML, # and PDF formats. # - docnodes = {} for doc in docs: # @@ -328,16 +342,16 @@ else: cleanopt = ' -c' scdir = os.path.join(build, doc) sctargets = [] - if 'html' in docs[doc]: + if 'html' in docs[doc][DOCTARGETS]: sctargets.append(env.File(os.path.join(scdir, 'index.html'))) - if 'chunked' in docs[doc]: + if 'chunked' in docs[doc][DOCTARGETS]: sctargets.append(env.File(os.path.join(scdir, 'scons-%s' % doc, 'index.html'))) - if 'pdf' in docs[doc]: + if 'pdf' in docs[doc][DOCTARGETS]: sctargets.append(env.File(os.path.join(scdir, 'scons-%s.pdf' % doc))) - if 'epub' in docs[doc]: + if 'epub' in docs[doc][DOCTARGETS]: sctargets.append(env.File(os.path.join(scdir, 'scons-%s.epub' % doc))) - if 'man' in docs[doc]: + if 'man' in docs[doc][DOCTARGETS]: for m in man_page_list: sctargets.append(os.path.join(scdir, m)) man, _1 = os.path.splitext(m) @@ -345,8 +359,8 @@ else: sctargets.append(os.path.join(scdir, 'scons-%s.pdf' % man)) sctargets.append(os.path.join(scdir, 'scons-%s.html' % man)) - docnodes[doc] = env.Command(sctargets, buildsuite, - "cd %s && $PYTHON ${SCONS_PY.abspath}%s" % (scdir, cleanopt)) + docs[doc][DOCNODES].extend(env.Command(sctargets, buildsuite + docs[doc][DOCDEPENDS], + "cd %s && $PYTHON ${SCONS_PY.abspath}%s" % (scdir, cleanopt))) install_css = False for doc in docs: @@ -358,20 +372,20 @@ else: pdf = os.path.join(build, 'PDF', 'scons-%s.pdf' % doc) epub = os.path.join(build, 'EPUB', 'scons-%s.epub' % doc) text = os.path.join(build, 'TEXT', 'scons-%s.txt' % doc) - if 'chunked' in docs[doc]: + if 'chunked' in docs[doc][DOCTARGETS]: installed_chtml = env.ChunkedInstall(env.Dir(htmldir), os.path.join(build, doc,'scons-%s' % doc, 'index.html')) installed_chtml_css = env.Install(env.Dir(htmldir), os.path.join(build, doc, 'scons.css')) - env.Depends(installed_chtml, docnodes[doc]) - env.Depends(installed_chtml_css, docnodes[doc]) + env.Depends(installed_chtml, docs[doc][DOCNODES]) + env.Depends(installed_chtml_css, docs[doc][DOCNODES]) tar_deps.extend([htmlindex, installed_chtml_css]) tar_list.extend([htmldir]) Local(htmlindex) env.Ignore(htmlindex, version_xml) - if 'html' in docs[doc]: + if 'html' in docs[doc][DOCTARGETS]: env.InstallAs(env.File(html), env.File(os.path.join(build, doc,'index.html'))) tar_deps.extend([html]) tar_list.extend([html]) @@ -379,7 +393,7 @@ else: env.Ignore(html, version_xml) install_css = True - if 'pdf' in docs[doc]: + if 'pdf' in docs[doc][DOCTARGETS]: env.InstallAs(env.File(pdf), env.File(os.path.join(build, doc,'scons-%s.pdf' % doc))) Local(pdf) env.Ignore(pdf, version_xml) @@ -387,7 +401,7 @@ else: tar_deps.append(pdf) tar_list.append(pdf) - if 'epub' in docs[doc] and gs: + if 'epub' in docs[doc][DOCTARGETS] and gs: env.InstallAs(env.File(epub), env.File(os.path.join(build, doc,'scons-%s.epub' % doc))) Local(epub) env.Ignore(epub, version_xml) @@ -395,8 +409,8 @@ else: tar_deps.append(epub) tar_list.append(epub) - if ('text' in docs[doc] and lynx and - (('html' in docs[doc]) or (doc == 'man'))): + if ('text' in docs[doc][DOCTARGETS] and lynx and + (('html' in docs[doc][DOCTARGETS]) or (doc == 'man'))): texthtml = os.path.join(build, doc,'index.html') if doc == 'man': # Special handling for single MAN file @@ -411,7 +425,7 @@ else: tar_list.append(text) - if 'man' in docs[doc]: + if 'man' in docs[doc][DOCTARGETS]: # # Man page(s) # -- cgit v1.2.1 From 08b16e35b58ef0a5118a683d376fafeb3a1a933d Mon Sep 17 00:00:00 2001 From: anatoly techtonik Date: Wed, 28 May 2014 11:36:26 +0300 Subject: Fix development mailing list with a new address @scons.org --- doc/scons.mod | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/scons.mod b/doc/scons.mod index 01e9a6da..be2dc242 100644 --- a/doc/scons.mod +++ b/doc/scons.mod @@ -525,8 +525,8 @@ --> announce@scons.tigris.org"> -dev@scons.tigris.org"> -users@scons.tigris.org"> +scons-dev@scons.org"> +scons-users@scons.org">