[Bash-completion-commits] [SCM] bash-completion branch, master, updated. abad9538c4f1a4d214ebc68d01acf5c8e38a93ab

[David Paleino]

The following commit has been merged in the master branch:
commit abad9538c4f1a4d214ebc68d01acf5c8e38a93ab
Author: David Paleino <d.paleino at gmail.com>
Date:   Thu Apr 16 09:57:24 2009 +0200

    doc/main.xml is auto-generated, ignore it

diff --git a/.gitignore b/.gitignore
index fa7cae8..dccc755 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,3 +8,4 @@ config.status
 configure
 install-sh
 missing
+doc/*.xml
diff --git a/doc/main.xml b/doc/main.xml
deleted file mode 100644
index 4f04188..0000000
--- a/doc/main.xml
+++ /dev/null
@@ -1,151 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-
-<book lang="en">
-<bookinfo>
-    <title>Bash-completion</title>
-    <date>Mar 2009</date>
-    <author>
-        <firstname>Freddy</firstname>
-        <othername>Vulto</othername>
-        <surname>(FVu)</surname>
-    </author>
-    <authorinitials>FV(</authorinitials>
-
-<revhistory><revision><revnumber>1.0</revnumber><date>Mar 2009</date><authorinitials>FV(</authorinitials></revision></revhistory>
-
-</bookinfo>
-<preface>
-<title>Preface</title>
-</preface>
-<part id="_coding_style_guide">
-<title>Coding Style Guide</title>
-<simpara>This document attempts to explain the basic styles and patterns that are used in the bash completion.  New code should try to conform to these standards so that it is as easy to maintain as existing code.  Of course every rule has an exception, but it's important to know the rules nonetheless!</simpara>
-
-<simpara>This is particularly directed at people new to the bash completion codebase, who are in the process of getting their code reviewed.  Before getting a review, please read over this document and make sure your code conforms to the recommendations here.</simpara>
-
-</part>
-<part id="_automated_testing">
-<title>Automated testing</title>
-<chapter id="_introduction">
-<title>Introduction</title>
-<simpara>The bash-completion package contains an automated test suite.  Running the tests should help verifying that bash-completion works as expected.  The tests are also very helpful in uncovering software regressions at an early stage.</simpara>
-
-<simpara>The bash-completion test suite is written on top of the <ulink url="http://www.gnu.org/software/dejagnu/">DejaGnu</ulink> testing framework.  DejaGnu is written in <ulink url="http://expect.nist.gov">Expect</ulink>, which in turn uses <ulink url="http://tcl.sourceforge.net">Tcl</ulink> &#8212; Tool command language.</simpara>
-
-</chapter>
-<chapter id="_installing_dejagnu">
-<title>Installing DejaGnu</title>
-<simpara>Installing DejaGnu should be easy using your local package manager.</simpara>
-
-<section id="_debian_ubuntu">
-<title>Debian/Ubuntu</title>
-<simpara>On Debian/Ubuntu you can use <literal>apt-get</literal>:</simpara>
-
-<screen>sudo apt-get install dejagnu</screen>
-<simpara>This should also install the necessary <literal>expect</literal> and <literal>tcl</literal> packages.</simpara>
-
-</section>
-</chapter>
-<chapter id="_structure">
-<title>Structure</title>
-<section id="_main_areas_dejagnu_tools">
-<title>Main areas (DejaGnu tools)</title>
-<simpara>The tests are grouped into different areas, called <emphasis>tool</emphasis> in DejaGnu:</simpara>
-
-<variablelist>
-<varlistentry>
-<term>
-<emphasis role="strong">install</emphasis>
-</term>
-<listitem>
-<simpara>
-  Functional tests for installation and caching of the main bash-completion package.
-</simpara>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term>
-<emphasis role="strong">completion</emphasis>
-</term>
-<listitem>
-<simpara>
-  Functional tests per completion.
-</simpara>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term>
-<emphasis role="strong">unit</emphasis>
-</term>
-<listitem>
-<simpara>
-  Unit tests for bash-completion helper functions.
-</simpara>
-</listitem>
-</varlistentry>
-</variablelist>
-</section>
-<section id="_running_the_tests">
-<title>Running the tests</title>
-<simpara>The tests are run by calling <literal>runtest</literal> in the test directory:</simpara>
-
-<screen>runtest --outdir=log --tool completion
-runtest --outdir=log --tool install
-runtest --outdir=log --tool unit</screen>
-<simpara>The commands above are already wrapped up in shell scripts within the <literal>test</literal> directory:</simpara>
-
-<screen>./runCompletion
-./runInstall
-./runUnit</screen>
-</section>
-</chapter>
-<chapter id="_maintenance">
-<title>Maintenance</title>
-<section id="_adding_a_completion_test">
-<title>Adding a completion test</title>
-<simpara>You can add script/generate to add a test.</simpara>
-
-</section>
-</chapter>
-<chapter id="_rationale">
-<title>Rationale</title>
-<section id="_naming_conventions">
-<title>Naming conventions</title>
-<section id="_test_suite_or_testsuite">
-<title>Test suite or testsuite</title>
-<simpara>The primary Wikipedia page is called
-<ulink url="http://en.wikipedia.org/wiki/Test_suite">test suite</ulink> and not testsuite, so that's what this
-document sticks to.</simpara>
-
-</section>
-<section id="_script_generate">
-<title>script/generate</title>
-<simpara>The name and location of this code generation script come from Ruby on Rails' <ulink url="http://en.wikibooks.org/wiki/Ruby_on_Rails/Tools/Generators">script/generate</ulink>.</simpara>
-
-</section>
-</section>
-</chapter>
-<chapter id="_reference">
-<title>Reference</title>
-<simpara>Within test scripts the following library functions can be used:</simpara>
-
-</chapter>
-<chapter id="_the_test_environment">
-<title>The test environment</title>
-<simpara>The tests run in a specially prepared bash environment.  The following files are used:
-<emphasis role="strong"> bashrch
-</emphasis> inputrc
-* fixtures</simpara>
-
-<section id="_bashrc">
-<title>bashrc</title>
-<simpara>Contents of bashrc:</simpara>
-
-</section>
-</chapter>
-</part>
-<index id="_index">
-<title>Index</title>
-</index>
-</book>

-- 
bash-completion