remove cdist-environment, merge into HACKERS_README, update that as well
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
parent
250dedc1c8
commit
45cc072d21
3 changed files with 10 additions and 35 deletions
|
@ -11,13 +11,19 @@ Do not believe anything written in cdist, besides what's written in this file
|
||||||
-- Nico, 20101201
|
-- Nico, 20101201
|
||||||
|
|
||||||
|
|
||||||
What you can do so far: (executed from top level directory)
|
## Conventions
|
||||||
|
|
||||||
The following code will get executed if you run this README,
|
- All variables exported by cdist are prefixed with a double underscore (__)
|
||||||
I usually do it like this:
|
- All cdist-internal variables are prefixed with __cdist_ and are generally not exported.
|
||||||
|
|
||||||
|
## Running cdist when developing
|
||||||
|
|
||||||
|
This file is suitable for execution and saving the objects and
|
||||||
|
explorers from cdist. I usually do it like this:
|
||||||
|
|
||||||
% rm -rf /tmp/localhost && ./HACKERS_README
|
% rm -rf /tmp/localhost && ./HACKERS_README
|
||||||
|
|
||||||
|
################################################################################
|
||||||
eof
|
eof
|
||||||
|
|
||||||
# Tell the user what we do, so this script makes sense during execution
|
# Tell the user what we do, so this script makes sense during execution
|
||||||
|
|
1
TODO-1.0
1
TODO-1.0
|
@ -43,6 +43,7 @@ x generate code to be executed on clients (stage 4)
|
||||||
x execute code on client (stage 5)
|
x execute code on client (stage 5)
|
||||||
|
|
||||||
- Last doc stuff for 1.0.0:
|
- Last doc stuff for 1.0.0:
|
||||||
|
- remove old documentation from doc/man/!
|
||||||
- ensure every file in bin/ has a correspondent manpage
|
- ensure every file in bin/ has a correspondent manpage
|
||||||
- cdist-quickstart [WRITE]
|
- cdist-quickstart [WRITE]
|
||||||
- how to write a minimal host manifest
|
- how to write a minimal host manifest
|
||||||
|
|
|
@ -1,32 +0,0 @@
|
||||||
cdist-environment(7)
|
|
||||||
====================
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-environment - Which environment cdist sets up
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
|
|
||||||
PREFIXES
|
|
||||||
--------
|
|
||||||
|
|
||||||
These prefixes are supposed to be used. If you write a new type, you
|
|
||||||
should stick to these conventions.
|
|
||||||
|
|
||||||
- __: All variables setup by cdist are prefixed with a double _
|
|
||||||
- __cdist_: Variables setup by the cdist core
|
|
||||||
- __<type>_<name>: Variable <name> setup by type <type>
|
|
||||||
|
|
||||||
|
|
||||||
EXAPMLES
|
|
||||||
--------
|
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
|
||||||
-------
|
|
||||||
Copyright \(C) 2010-2011 Nico Schottelius. Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
|
Loading…
Reference in a new issue