diff options
| author | Freddy Vulto <fvulto@gmail.com> | 2009-04-20 10:07:29 +0200 |
|---|---|---|
| committer | Freddy Vulto <fvulto@gmail.com> | 2009-04-20 10:07:29 +0200 |
| commit | ec2e190cbb14aa952499805a534dacd3f3be6fe4 (patch) | |
| tree | 7c173cb1de450bbdd1926fc5a3baefe56d14176f /doc | |
| parent | 65c2ea97aeee309eb1b4f25241885550d2f7805e (diff) | |
| download | bash-completion-ec2e190cbb14aa952499805a534dacd3f3be6fe4.tar.gz | |
Fixed asciidoc-8.4.3 errors
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/main.txt | 8 | ||||
| -rw-r--r-- | doc/styleguide.txt | 6 |
2 files changed, 12 insertions, 2 deletions
diff --git a/doc/main.txt b/doc/main.txt index 93ab1062..d9cdd822 100644 --- a/doc/main.txt +++ b/doc/main.txt @@ -3,6 +3,14 @@ Bash-completion Freddy Vulto (FVu) v1.0, Mar 2009 +Preface +======= +Bash completion extends bashs standard completion behavior to achieve +complex command lines with just a few keystrokes. This project was +conceived to produce programmable completion routines for the most +common Linux/UNIX commands, reducing the amount of typing sysadmins +and programmers need to do on a daily basis. + // include::intro.txt[] // include::bash_completion.txt[] diff --git a/doc/styleguide.txt b/doc/styleguide.txt index 7dd7c204..d945b1d0 100644 --- a/doc/styleguide.txt +++ b/doc/styleguide.txt @@ -1,6 +1,8 @@ Coding Style Guide ================== +Introduction +------------ 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. @@ -13,8 +15,8 @@ simple matching vs extended globbing ------------------------------------ in case statements: -@(a|b)) vs -a|-b) -[[ ]] vs [ ] ------------- +testing with [[ ]] vs [ ] +------------------------- indentation ----------- |