diff --git a/bin/build_lists_pgm.bat b/bin/build_lists_pgm.bat new file mode 100644 index 0000000..a8a3f70 --- /dev/null +++ b/bin/build_lists_pgm.bat @@ -0,0 +1 @@ +g++ %* -std=c++11 -o bin/lists.exe src/date.cpp src/issues.cpp src/sections.cpp src/mailing_info.cpp src/report_generator.cpp src/file_names.cpp src/lists.cpp diff --git a/bin/build_pgms.bat b/bin/build_pgms.bat index 24e347d..5d1a707 100644 --- a/bin/build_pgms.bat +++ b/bin/build_pgms.bat @@ -1,5 +1,5 @@ echo "Use -m32 switch to force 32-bit build" -g++ %* -std=c++11 -DNDEBUG -O2 -o bin/lists.exe src/date.cpp src/issues.cpp src/sections.cpp src/mailing_info.cpp src/report_generator.cpp src/lists.cpp +g++ %* -std=c++11 -DNDEBUG -O2 -o bin/lists.exe src/date.cpp src/issues.cpp src/sections.cpp src/mailing_info.cpp src/report_generator.cpp src/file_names.cpp src/lists.cpp g++ %* -std=c++11 -o bin/section_data.exe src/section_data.cpp g++ %* -std=c++11 -o bin/toc_diff.exe src/toc_diff.cpp g++ %* -std=c++11 -DNDEBUG -O2 -o bin/list_issues.exe src/date.cpp src/issues.cpp src/sections.cpp src/list_issues.cpp diff --git a/bin/build_pgms.sh b/bin/build_pgms.sh index 5ce5968..4758a60 100755 --- a/bin/build_pgms.sh +++ b/bin/build_pgms.sh @@ -1,6 +1,6 @@ #!/bin/sh echo '"Use -m32 switch to force 32-bit build"' -g++ $* -std=c++11 -DNDEBUG -O2 -o bin/lists src/date.cpp src/issues.cpp src/sections.cpp src/mailing_info.cpp src/report_generator.cpp src/lists.cpp +g++ $* -std=c++11 -DNDEBUG -O2 -o bin/lists src/date.cpp src/issues.cpp src/sections.cpp src/mailing_info.cpp src/report_generator.cpp src/file_names.cpp src/lists.cpp g++ $* -std=c++11 -o bin/section_data src/section_data.cpp g++ $* -std=c++11 -o bin/toc_diff src/toc_diff.cpp g++ $* -std=c++11 -DNDEBUG -O2 -o bin/list_issues src/date.cpp src/issues.cpp src/sections.cpp src/list_issues.cpp diff --git a/getting-started.html b/getting-started.html new file mode 100644 index 0000000..91658a6 --- /dev/null +++ b/getting-started.html @@ -0,0 +1,93 @@ + + +
+ + + + +This software builds HTML issues lists from XML files. Tables of
+contents and index files are also created, also formatted in HTML. There is one input
+XML
+file for each issue. The file config.xml
provides configuration
+attributes and text that tailors the output so that the same software works for
+the C++ Standard Library itself and also the various library Technical Specifications. It
+may also be useful for tracking issues for non-library documents, but most
+current use is with library related issues.
The code is written in C++ and requires a C++ 14 compiler and library. It is +works on Linux, OS X, and Windows.
+The source code should not require changes to be set up for a new IS or TS +document. Please contact the maintainers if you need help.
+Prerequisites for either setting up a new list or maintaining an existing +list:
+git
operations you will
+ need to maintain an issues list are baked into POSIX .sh
and Windows
+ .bat
scripts provided, so you do not need to be an experienced Git user.A public Git +repository for the software is maintained on the C++ committee's +GitHub account.
+The +Git Flow +model for repository workflow is at least roughly followed because it works well +and is familiar to many developers. Because this is a simple project, only the +master and develop branches are always active. +Feature branches are used when new features are under development.
+ +++cd some-directory +git clone git@github.com:cplusplus/lib-issues-software.git +cd lib-issues-software +bin/build_pgms.sh+
++cd some-directory +git clone git@github.com:cplusplus/lib-issues-software.git +cd lib-issues-software +bin\build_pgms+
These instructions assume you prefer to interact with GitHub via
+SSH. You can also use https://github.com/cplusplus/lib-issues-software.git
+as the URL in the instructions above; this may work better if you are behind a
+firewall.
+
+ +
Howard Hinnant was the original author. The current maintainer is +Alisdair Meredith, backed up by Beman Dawes and Daniel Krügler.
+ +Revised: +19 March 2014
++ + + + \ No newline at end of file diff --git a/how-to-docs.html b/how-to-docs.html index 25c5e36..9b3d553 100644 --- a/how-to-docs.html +++ b/how-to-docs.html @@ -10,10 +10,14 @@ -
Revised: -20 May 2013
+Revised: +19 March 2014
Warning: These instructions were originally written for the Standard +Library issues list without any consideration of using the software for other +lists. They have not yet been updated to cover other uses.
These instruction assume you going to keep the issues lists source files in a directory named "issues", and the issues lists generated HTML files in a directory named "issues-gh-pages".
@@ -23,32 +27,34 @@How To Instructions
.bat
scripts, or
- a POSIX environment is a prerequisite to use the equivalent .sh
- scripts.Follow the Getting Started with Library Issues List Software +installation instructions. Install the +Prequisites given there first +if necessary and set up the GitHub public repository.
+ +Do this once only:
-+mkdir mailing -cd path-to-where-you-want-to-keep-this-stuff +POSIX and Windows: +cd some-directory git clone git@github.com:cplusplus/LWG.git issues git clone -b gh-pages git@github.com:cplusplus/LWG.git issues-gh-pages cd issues -mkdir mailing-
Do this after the initial setup, and then again whenever the source
-code (in issues/src
) changes.
-+cd issues -bin\build_pgms+Windows: +mklink /d bin path\library-issues-software\bin + +POSIX: +ln path/library-issues-software/bin bin
The final instruction creates a symlink bin
to the directory
+containing the issues list software. An alternative would be to add that
+directory to your path, but the names are fairly generic so that might well
+result in unwelcome name clashes.
There is one source file per issue, in issues/xml
. The file
issues/xml/lwg-template.xml
can be used as a template to start a
@@ -192,4 +198,4 @@