https://github.com/ptomulik/scons-gnu-variables
Provides GNU Makefile variables to SCons environments
https://github.com/ptomulik/scons-gnu-variables
Last synced: 3 months ago
JSON representation
Provides GNU Makefile variables to SCons environments
- Host: GitHub
- URL: https://github.com/ptomulik/scons-gnu-variables
- Owner: ptomulik
- License: mit
- Created: 2012-06-11T04:14:00.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2015-11-07T23:17:46.000Z (over 9 years ago)
- Last Synced: 2025-01-18T02:28:40.615Z (5 months ago)
- Language: Python
- Size: 211 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SConsGnuVariables
=================
**THIS PROJECT IS DISCONTINUED -- PLEASE DO NOT USE**
See [scons-gnu-arguments](https://github.com/ptomulik/scons-gnu-arguments)
Welcome to SConsGnuVariables.
This package provides SCons with GNU variables (e.g. direcory variables)
commonly used by GNU build system (autotools). With this package you may
easilly add to your command line variables such as ``prefix``, ``bindir`` or
options such as ``--prefix``, ``--bindir``. An appropriate construction
variables may be also easilly created within SCons ``Enrvironment`` object.
INSTALLATION
------------
Copy entire directory ``SConsGnuVariables`` to your local ``site_scons``.
cp -r scons-gnu-variables/SConsGnuVariables your/project/site_scons/
USAGE
-----
The package contains modules with python functions. To use it see API
documentation (to generate it, see [DOCUMENTATION](#documentation)).
### GnuDirVariables
Here is an example of what may be put to ``SConsctruct`` in order to add
all supported GNU directory variables to your scons command line variables
```python
# SConstruct #
from SConsGnuVariables import GnuDirVariables
env = Environment()
gnuvars = GnuDirVariables.AsSConsVariables()
gnuvars.Update(env, ARGUMENTS)
print "${prefix}: ", env.subst('${prefix}')
print "${bindir}: ", env.subst('${bindir}')
```
The result of ``scons -Q`` will be
```
${prefix}: /usr/local
${bindir}: /usr/local/bin
scons: `.' is up to date.
```
The result of ``scons -Q prefix=/usr`` will be
```
${prefix}: /usr
${bindir}: /usr/bin
scons: `.' is up to date.
```
### AmUniformNames
The package also provides ``automake uniform naming`` enclosed within module
``SConsGnuVariables.AmUniformNames``. This module mainly keeps organized
standard uniform names such as ``nobase_include_HEADERS`` or ``bin_PROGRAMS``.
For more information see module's API documentation.
DOCUMENTATION
-------------
API documentation can be generated from top level directory with the following
command
```
scons api-doc
```
To generate documentation, you may need following packages on your system:
* epydoc
* python-docutils
* python-pygments
The generated documentation is located within ``doc/api`` directory.
RUNNING EXAMPLES
----------------
Each example consists of its ``SConscript`` file located under examples/exN,
and ocassionally may involve other files within same directory.
The examples should be run from top-level directory by invoking
```
scons ex1 # For example/ex1
scons ex1 --help # It may be worth to see help message
...
```
LICENSE
-------
Copyright © 2012 by Paweł Tomulik
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE