Check out my first novel, midnight's simulacra!

Source trees: Difference between revisions

From dankwiki
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
==Rules for source trees==
Rules for source trees, collected over the years.
Rule: <b><tt>make clean</tt> in a pristine source tree ought be idempotent</b>
 
==Targets==
* Honor the standard targets of the [http://www.gnu.org/prep/standards/html_node/Standard-Targets.html FSF coding standards]:
** <tt>all</tt> compiles all installable object files, and usually not documentation
** <tt>install</tt> publishes object files. <tt>uninstall</tt> removes them. neither ought write within the tree.
** <tt>dist</tt> rolls up a distributable.
==Cleanup==
<b>Rule: <tt>make clean</tt> in a pristine source tree ought be idempotent</b>
* Never remove controlled files as part of a <tt>make clean</tt>
* Never remove controlled files as part of a <tt>make clean</tt>
===Generated files===
* Never build files as part of a <tt>make clean</tt>
Rule: <b><tt>make all</tt> in a pristine source tree oughtn't change files in source control</b>
** <tt>svn status --no-ignore</tt> ought generate the same output across multiple <tt>clean</tt> runs
==Generated files==
<b>Rule: <tt>make all</tt> in a pristine source tree oughtn't change files in source control</b>
* Don't keep generated files in source control
* Don't keep generated files in source control
** It ought be possible to write a <tt>make clean</tt> which operates entirely based off "ignore" properties
** It ought be possible to write a <tt>make clean</tt> which operates entirely based off "ignore" properties
Rule: <b><tt>make all</tt> oughtn't generate files unknown to source control</b>
<b>Rule: <tt>make all</tt> oughtn't generate files unknown to source control</b>
* Use source control systems' "ignore" capabilities
* Use source control systems' "ignore" capabilities
** <tt>svn status</tt> oughtn't generate output following a <tt>make all</tt>
** <tt>svn status</tt> oughtn't generate output following a <tt>make all</tt>

Latest revision as of 23:18, 1 June 2010

Rules for source trees, collected over the years.

Targets

  • Honor the standard targets of the FSF coding standards:
    • all compiles all installable object files, and usually not documentation
    • install publishes object files. uninstall removes them. neither ought write within the tree.
    • dist rolls up a distributable.

Cleanup

Rule: make clean in a pristine source tree ought be idempotent

  • Never remove controlled files as part of a make clean
  • Never build files as part of a make clean
    • svn status --no-ignore ought generate the same output across multiple clean runs

Generated files

Rule: make all in a pristine source tree oughtn't change files in source control

  • Don't keep generated files in source control
    • It ought be possible to write a make clean which operates entirely based off "ignore" properties

Rule: make all oughtn't generate files unknown to source control

  • Use source control systems' "ignore" capabilities
    • svn status oughtn't generate output following a make all