josh/rscons
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

update documentation for new builders

Browse Source
This commit is contained in:
Josh Holtrop 2014-04-15 16:06:00 -04:00
parent d424facf7f
commit 8be1842cf8
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -208,8 +208,10 @@ end
Rscons ships with a number of builders: Rscons ships with a number of builders:
* CFile, which builds a C or C++ source file from a lex or yacc input file * CFile, which builds a C or C++ source file from a lex or yacc input file
* Disassemble, which disassembles an object file to a disassembly listing
* Library, which collects object files into a static library archive file * Library, which collects object files into a static library archive file
* Object, which compiles source files to produce an object file * Object, which compiles source files to produce an object file
* Preprocess, which invokes the C/C++ preprocessor on a source file
* Program, which links object files to produce an executable * Program, which links object files to produce an executable
If you want to create an Environment that does not contain any builders, If you want to create an Environment that does not contain any builders,
@ -219,15 +221,30 @@ you can use the `exclude_builders` key to the Environment constructor.
```ruby ```ruby
env.CFile(target, source) env.CFile(target, source)
# Example
env.CFile("parser.c", "parser.y")
``` ```
The CFile builder will generate a C or C++ source file from a lex (.l, .ll) The CFile builder will generate a C or C++ source file from a lex (.l, .ll)
or yacc (.y, .yy) input file. or yacc (.y, .yy) input file.
#### Disassemble
```ruby
env.Disassemble(target, source)
# Example
env.Disassemble("module.dis", "module.o")
```
The Disassemble builder generates a disassembly listing using objdump from
and object file.
#### Library #### Library
```ruby ```ruby
env.Library(target, sources) env.Library(target, sources)
# Example
env.Library("lib.a", Dir["src/**/*.c"])
``` ```
The Library builder creates a static library archive from the given source The Library builder creates a static library archive from the given source
@ -237,14 +254,30 @@ files.
```ruby ```ruby
env.Object(target, sources) env.Object(target, sources)
# Example
env.Object("module.o", "module.c")
``` ```
The Object builder compiles the given sources to an object file. The Object builder compiles the given sources to an object file.
#### Preprocess
```ruby
env.Preprocess(target, source)
# Example
env.Preprocess("module-preprocessed.cc", "module.cc")
```
The Preprocess builder invokes either ${CC} or ${CXX} (depending on if the
source contains an extension in ${CXXSUFFIX} or not) and writes the
preprocessed output to the target file.
#### Program #### Program
```ruby ```ruby
env.Program(target, sources) env.Program(target, sources)
# Example
env.Program("myprog", Dir["src/**/*.cc"])
``` ```
The Program builder compiles and links the given sources to an executable file. The Program builder compiles and links the given sources to an executable file.