diff --git a/.gitignore b/.gitignore index fa7cae84..dccc755a 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 4f04188a..00000000 --- a/doc/main.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - Bash-completion - Mar 2009 - - Freddy - Vulto - (FVu) - - FV( - -1.0Mar 2009FV( - - - -Preface - - -Coding Style Guide -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! - -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. - - - -Automated testing - -Introduction -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. - -The bash-completion test suite is written on top of the DejaGnu testing framework. DejaGnu is written in Expect, which in turn uses Tcl — Tool command language. - - - -Installing DejaGnu -Installing DejaGnu should be easy using your local package manager. - -
-Debian/Ubuntu -On Debian/Ubuntu you can use apt-get: - -sudo apt-get install dejagnu -This should also install the necessary expect and tcl packages. - -
-
- -Structure -
-Main areas (DejaGnu tools) -The tests are grouped into different areas, called tool in DejaGnu: - - - - -install - - - - Functional tests for installation and caching of the main bash-completion package. - - - - - -completion - - - - Functional tests per completion. - - - - - -unit - - - - Unit tests for bash-completion helper functions. - - - - -
-
-Running the tests -The tests are run by calling runtest in the test directory: - -runtest --outdir=log --tool completion -runtest --outdir=log --tool install -runtest --outdir=log --tool unit -The commands above are already wrapped up in shell scripts within the test directory: - -./runCompletion -./runInstall -./runUnit -
-
- -Maintenance -
-Adding a completion test -You can add script/generate to add a test. - -
-
- -Rationale -
-Naming conventions -
-Test suite or testsuite -The primary Wikipedia page is called -test suite and not testsuite, so that's what this -document sticks to. - -
-
-script/generate -The name and location of this code generation script come from Ruby on Rails' script/generate. - -
-
-
- -Reference -Within test scripts the following library functions can be used: - - - -The test environment -The tests run in a specially prepared bash environment. The following files are used: - bashrch - inputrc -* fixtures - -
-bashrc -Contents of bashrc: - -
-
-
- -Index - -