Ticket #362: fileIsImportant-docs.patch

File fileIsImportant-docs.patch, 2.0 kB (added by clepple, 3 months ago)

patch for buildbot.texinfo

  • buildbot.texinfo

    old new  
    15221522 
    15231523It also has a list of @code{files}, which are just the tree-relative 
    15241524filenames of any files that were added, deleted, or modified for this 
    1525 Change. These filenames are used by the @code{isFileImportant} 
     1525Change. These filenames are used by the @code{fileIsImportant} 
    15261526function (in the Scheduler) to decide whether it is worth triggering a 
    1527 new build or not, e.g. the function could use 
    1528 @code{filename.endswith(".c")} to only run a build if a C file were 
    1529 checked in. Certain BuildSteps can also use the list of changed files 
     1527new build or not, e.g. the function could use the following function 
     1528to only run a build if a C file were checked in: 
     1529 
     1530@example 
     1531def has_C_files(change): 
     1532    for name in change.files: 
     1533        if name.endswith(".c"): 
     1534            return True 
     1535    return False 
     1536@end example 
     1537 
     1538Certain BuildSteps can also use the list of changed files 
    15301539to run a more targeted series of tests, e.g. the 
    15311540@code{python_twisted.Trial} step can run just the unit tests that 
    15321541provide coverage for the modified .py files instead of running the 
    …… 
    15511560@item CVS 
    15521561@code{revision} is an int, seconds since the epoch 
    15531562@item SVN 
    1554 @code{revision} is an int, a transation number (r%d) 
     1563@code{revision} is an int, the changeset number (r%d) 
    15551564@item Darcs 
    15561565@code{revision} is a large string, the output of @code{darcs changes --context} 
    15571566@item Mercurial 
    …… 
    16321641feed multiple Builders (with a @code{mode=} of @code{'copy'}, 
    16331642@code{'clobber'}, or @code{'export'}). 
    16341643 
    1635 The @code{tree-stable-timer} and @code{isFileImportant} decisions are 
     1644The @code{tree-stable-timer} and @code{fileIsImportant} decisions are 
    16361645made by the Scheduler. Dependencies are also implemented here. 
    16371646Periodic builds (those which are run every N seconds rather than after 
    16381647new Changes arrive) are triggered by a special @code{Periodic}