summaryrefslogtreecommitdiffstats
path: root/source-builder/sb/asciidoc/filters/code/code-filter-readme.txt
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-08-07 09:59:49 +1000
committerChris Johns <chrisj@rtems.org>2017-08-07 09:59:49 +1000
commit8b96e17c8abf61d97dd224b23370dc148f32fe3c (patch)
treee8eb043159d145ffbbbf9c23ef872226de5ab059 /source-builder/sb/asciidoc/filters/code/code-filter-readme.txt
parent4.12: Fix SIS patch URL (diff)
downloadrtems-source-builder-8b96e17c8abf61d97dd224b23370dc148f32fe3c.tar.bz2
doc: Remove in source documentation and the asciidoc package
The RSB documentation is now in ReST format and part of the RTEMS Documentation project. See https://docs.rtems.org/. Remove support for the GPL based asciidoc tool and remove the asciidoc package from the RSB. Add the Python Markdown package and update the reporter to use Markdown for HTML generation. The resuling HTML report is a single self contained file. Closes #3047.
Diffstat (limited to '')
-rw-r--r--source-builder/sb/asciidoc/filters/code/code-filter-readme.txt37
1 files changed, 0 insertions, 37 deletions
diff --git a/source-builder/sb/asciidoc/filters/code/code-filter-readme.txt b/source-builder/sb/asciidoc/filters/code/code-filter-readme.txt
deleted file mode 100644
index 2a35f86..0000000
--- a/source-builder/sb/asciidoc/filters/code/code-filter-readme.txt
+++ /dev/null
@@ -1,37 +0,0 @@
-AsciiDoc Code Filter
-====================
-
-This simple minded filter highlights source code keywords and
-comments.
-
-NOTE: The filter is to demonstrate how to write a filter -- it's much
-to simplistic to be passed off as a code syntax highlighter. If you
-want a full featured highlighter use the 'source highlighter filter.
-
-
-Files
------
-code-filter.py::
- The filter Python script.
-code-filter.conf::
- The AsciiDoc filter configuration file.
-code-filter-test.txt::
- Short AsciiDoc document to test the filter.
-
-
-Installation
-------------
-The code filter is installed in the distribution `filters` directory
-as part of the standard AsciiDoc install.
-
-Test it on the `code-filter-test.txt` file:
-
- $ asciidoc -v code-filter-test.txt
- $ firefox code-filter-test.txt &
-
-
-Help
-----
-Execute the filter with the help option:
-
- $ ./code-filter.py --help