diff options
| author | Steven Knight <knight@baldmt.com> | 2002-11-13 06:44:03 (GMT) |
|---|---|---|
| committer | Steven Knight <knight@baldmt.com> | 2002-11-13 06:44:03 (GMT) |
| commit | c3f2f406542da875245f96d9505b5bedde0a5de0 (patch) | |
| tree | ed5c9efe662ffd6e75bbd266b14442abfb39ec08 /src/engine/SCons/Node | |
| parent | 75a90274cf324056b49f53d634cd3f0c3c52fe85 (diff) | |
| download | SCons-c3f2f406542da875245f96d9505b5bedde0a5de0.zip SCons-c3f2f406542da875245f96d9505b5bedde0a5de0.tar.gz SCons-c3f2f406542da875245f96d9505b5bedde0a5de0.tar.bz2 | |
Document Repository and other methods, plus some added documentation to SCons.Node and SCons.Node.FS.
Diffstat (limited to 'src/engine/SCons/Node')
| -rw-r--r-- | src/engine/SCons/Node/FS.py | 3 | ||||
| -rw-r--r-- | src/engine/SCons/Node/__init__.py | 15 |
2 files changed, 18 insertions, 0 deletions
diff --git a/src/engine/SCons/Node/FS.py b/src/engine/SCons/Node/FS.py index 3b0e6ca..3e50d10 100644 --- a/src/engine/SCons/Node/FS.py +++ b/src/engine/SCons/Node/FS.py @@ -2,6 +2,9 @@ File system nodes. +These Nodes represent the canonical external objects that people think +of when they think of building software: files and directories. + This initializes a "default_fs" Node with an FS at the current directory for its own purposes, and for use by scripts or modules looking for the canonical default. diff --git a/src/engine/SCons/Node/__init__.py b/src/engine/SCons/Node/__init__.py index 1afc79f..2033663 100644 --- a/src/engine/SCons/Node/__init__.py +++ b/src/engine/SCons/Node/__init__.py @@ -2,6 +2,21 @@ The Node package for the SCons software construction utility. +This is, in many ways, the heart of SCons. + +A Node is where we encapsulate all of the dependency information about +any thing that SCons can build, or about any thing which SCons can use +to build some other thing. The canonical "thing," of course, is a file, +but a Node can also represent something remote (like a web page) or +something completely abstract (like an Alias). + +Each specific type of "thing" is specifically represented by a subclass +of the Node base class: Node.FS.File for files, Node.Alias for aliases, +etc. Dependency information is kept here in the base class, and +information specific to files/aliases/etc. is in the subclass. The +goal, if we've done this correctly, is that any type of "thing" should +be able to depend on any other type of "thing." + """ # |
