diff options
Diffstat (limited to 'manual.tex')
| -rw-r--r-- | manual.tex | 90 |
1 files changed, 88 insertions, 2 deletions
diff --git a/manual.tex b/manual.tex index c0033de..623e866 100644 --- a/manual.tex +++ b/manual.tex @@ -31,9 +31,16 @@ This is the manual for the Dead Simple Continuous Integration POSIX program. @node Installing @chapter Installing - @cindex Installing +@cindex Installing Details on installing DSCIP onto various systems. - + @node Downloading + @section Downloading + @cindex Downloading + Currently, the upstream repo for DSCIP is located at this + @url{https://www.opencode.net/charadon/dscip, Git Repo}. If your OS + doesn't have DSCIP packaged, you can download the @command{setup.sh} + from the releases page, and use that to install dscip. Alternatively, + you can clone the git repo into whatever directory you want. @node Unix @section Unix @cindex Installing on Unix @@ -201,10 +208,89 @@ set MSYSTEM=MINGW64 @node Using Templates @section Using Templates @cindex Using Templates + Templates are an easy way to quickly get a DSCIP instance up and + running. Since most developers tend to have all their projects build + almost the exact same way, you can easily create a git repo with your DSCIP + scripts and have the setup script copy them over. You can point to the + directory containing your templates by using the @option{-t} argument with + setup.sh. You find find an example of templates here at my + @url{https://www.opencode.net/charadon/my-dscip-templates-v1, Git Repo} @node Using +@chapter Using +@cindex Using + This chapter goes over how to actually use DSCIP. + @node Basic Variables + @section Basic Variables + @cindex Basic Variables + This section goes over variables that you can safely modify in + config.sh. + @subsection DSCIP_GITREPO + @cindex Basic Variables: DSCIP_GITREPO + This is the variable that determines what git repo DSCIP clones into + wrkdir. + @subsection DSCIP_NAME + @cindex Basic Variables: DSCIP_NAME + This variable determines the name of the program that's being build. + Mostly for use with the @command{post.sh} and @command{failed.sh} + scripts when publishing artifacts. + @subsection DSCIP_BRANCH + @cindex Basic Variables: DSCIP_BRANCH + This variable tells DSCIP which branch to clone. This is useful if + you develop in a branch other than master. + @subsection DSCIP_DAEMON + @cindex Basic Variables: DSCIP_DAEMON + This variable will tell DSCIP to not close, but rather stay open and + just sleep before re-running itself. Useful for Windows, if you + want DSCIP to run in shorter time periods than 60 seconds, or use + special features that your OS's init system gives. + @subsection DSCIP_DAEMON_FORK + @cindex Basic Variables: DSCIP_DAEMON_FORK + This variable tells DSCIP if it should run itself in the background. + Some init systems prefer one or the other, so consult your OS's + documentation. + @subsection DSCIP_SLEEP + @cindex Basic Variables: DSCIP_SLEEP + When in daemon mode, this controls how long DSCIP should wait + between attempted builds before checking for a new commit and + building if one exists. + @subsection DSCIP_OUTPUT_TO + @cindex Basic Variables: DSCIP_OUTPUT_TO + This variable tells DSCIP where to put logs. By default it puts all + output into output.txt. This is useful if, for example, you're + running DSCIP in daemon mode, and need to store logs somewhere else. + @node Advanced Variables + @section Advanced Variables + @cindex Advanced Variables + These are variables you should only change if you absolutely need to! + @subsection DSCIP_GITMODE + @cindex Advanced Variables: DSCIP_GITMODE + This tells DSCIP to, rather than delete the wrkdir and get a fresh + clone, to just pull changes. This is really only useful in + situations where you have limited bandwidth. + @subsection WORKING_DIRECTORY + @cindex Advanced Variables: WORKING_DIRECTORY + This should probably never be changed. The only situation that + *might* warrant changing it, is in a very restricted environment + where it *has* to run in a specific place. + @subsection DSCIP_@{PRE,BUILD,POST,FAILED@}_CMD + @cindex Advanced Variables: DSCIP_@{PRE,BUILD,POST,FAILED@}_CMD + These variables tell DSCIP where to find their respective scripts. Like + WORKING_DIRECTORY, this really shouldn't be changed and is really + only useful in situations that are very restrictive. + @subsection DSCIP_DISREGARD_COMMIT_CHECK + @cindex Advanced Variables: DSCIP_DISREGARD_COMMIT_CHECK + This variable tells DSCIP to ignore the commit check and just keep + rebuilding. This is useful for seeing if old/unmaintained software + will still build on modern systems. But other than that, should be + left off. + @subsection DSCIP_AUTO_UPDATE + @cindex Advanced Variables: DSCIP_AUTO_UPDATE + This variable tells DSCIP to run @command{update.sh}, and then run a + checksum on itself. If it's different from when it first launched, + It'll re-run itself. This is useful for manual installations. @node Platform Specifics |