summaryrefslogtreecommitdiff
path: root/HACKING.rst
Commit message (Collapse)AuthorAgeFilesLines
* doc/Makefile: Stage stored sessions from session-storedtristan/getting-startedTristan Van Berkom2018-06-161-3/+3
| | | | | | | Separate the revisioned provisional session html files such that the git tree does not become dirty as a result of a documentation build process - which messes up the docs version number and the version number printed in some command line output.
* doc/bst2html.py, doc/Makefile: Added --force optionTristan Van Berkom2018-06-161-5/+5
| | | | | | | | | | | If --force is not specified, then we'll skip session files in the case that all of the outputs exist. Now setting BST_FORCE_SESSION_REBUILD when building the docs will cause the session files to be rebuilt regardless of whether they exist or not. The .gitlab-ci.yml was also changed to use this and force rebuilds.
* doc/bst2html.py: Add support for `fake-output` when running commands.Tristan Van Berkom2018-06-161-0/+3
| | | | | | | | | | | | | When specifying a fake-output string, we don't really run the command or assume it was a `bst` command, and we pretend that `fake-output` was the output of the command. Specifying an empty string explicitly enables the behavior too for faking a command that has no stdout/stderr. This also adds the "remove-files" hack allowing the session scripts to remove files before executing commands (kind of unsure if we're gonna keep this...)
* doc: Improve the new console output html generatorTristan Van Berkom2018-06-131-13/+31
| | | | | | | | | | Before we were creating one description file for each output, making it easier to declare a make rule for it - but the result was that we would have to build things more and it takes a long time. Instead, now we have session files which describe a series of commands to run in a session, and each command optionally produces an output file.
* doc: Overhaul of page names and titlesTristan Van Berkom2018-06-131-2/+2
| | | | | | | | | | | | | | | | o Giving main pages simple word titles This makes the main page: * About * Installing * Using * Reference * Contributing o Now named all rst files with their parent page name as a prefix. o Also changed some titles to make overall consistent titles.
* doc: Don't allow setting a height on the generated session htmlTristan Van Berkom2018-06-121-3/+0
| | | | | | This was a bad idea and doesnt play well with mobile UIs, better off to just include the whole thing even if it's long, and let the backing page handle vertical scrolling.
* HACKING.rst: Added guidelines for adding examplesTristan Van Berkom2018-06-121-1/+78
| | | | And some instructions about generating `bst` output for documentation
* HACKING.rst: Fixing formatting of titles.Tristan Van Berkom2018-04-231-2/+2
| | | | Titles have 2 blank lines before them, and no blank lines after them.
* HACKING.rst: Add a section on BST_PROFILE and the artifact cache.Jim MacArthur2018-04-231-0/+33
|
* HACKING.rst: Add a note about arpy being required for docsTristan Maat2018-04-201-2/+8
|
* HACKING.rst: Fixing profiling section to follow rst formatting policyTristan Van Berkom2018-04-181-2/+2
| | | | Two empty lines before a section title, no empty line after the section title
* HACKING.rst: move location of useful linksJames Ennis2018-04-181-5/+2
|
* HACKING.rst: Include Documentation Formatting PolicyJames Ennis2018-04-181-1/+22
|
* HACKING.rst: Clarify policy that related issues must be mentioned in commit ↵Tristan Van Berkom2018-04-181-0/+3
| | | | | | messages. This was somehow less than obvious.
* Consistent titlingJames Ennis2018-04-171-12/+12
|
* HACKING.rst: Add integration and pytest notesTristan Maat2018-04-111-0/+19
|
* HACKING.rst: Documenting naming policy for private symbolsTristan Van Berkom2018-04-031-0/+95
| | | | This is a part of issue #285
* HACKING.rst: Be specific about the only pip packages required are the ↵Javier Jardón2018-03-291-3/+3
| | | | python3 ones
* Change theme to sphinx_rtd_themeJavier Jardón2018-03-201-0/+1
| | | | | The sphinx_rtd_theme is a sphinx theme designed to look modern and be mobile-friendly http://sphinx-rtd-theme.readthedocs.io/en/latest/index.html
* HACKING.rst: Mention benchmarking and profiling toolsSam Thursfield2018-03-071-0/+57
| | | | | | | | This adds a reference to the benchmarking tool generated as part of https://gitlab.com/BuildStream/buildstream/issues/205. It also documents recommended strategies for profiling, which fixes https://gitlab.com/BuildStream/buildstream/issues/206.
* HACKING.rst: Added instructions to properly format commit messages.Tristan Van Berkom2018-01-161-0/+20
|
* HACKING.rst: Added a section on feature proposals and patch submissionTristan Van Berkom2018-01-081-68/+47
| | | | | Also removed some things which are either of little importance, not worth mentioning, or covered already by the buildstream user documentation.
* HACKING.rst: the setup.py --addopts flag can only be given onceSam Thursfield2017-12-051-1/+1
|
* HACKING.rst: Adding a little reminder of how to invoke specific testsTristan Van Berkom2017-09-041-0/+6
|
* HACKING.rst: Added some additional notes about generating documentation and ↵Tristan Van Berkom2017-05-031-1/+40
| | | | man pages
* Remove apostrophes from grammatically incorrect instances of "it's"Paul Sherwood2017-02-111-2/+2
|
* HACKING.rst: Remark about pep8 linter in coding styleTristan Van Berkom2017-02-051-2/+4
|
* HACKING.rst: Recommend better method of developer installTristan Van Berkom2017-02-051-23/+12
|
* HACKING.rst fixupTristan Van Berkom2016-11-161-3/+2
|
* HACKING rst related changesTristan Van Berkom2016-11-161-22/+34
|
* Adding more sections to HACKING.rstTristan Van Berkom2016-11-151-1/+50
|
* HACKING file fixupTristan Van Berkom2016-11-151-1/+4
|
* HACKING.rst: restructuredtext fixupsTristan Van Berkom2016-11-151-17/+9
|
* Adding HACKING.rstTristan Van Berkom2016-11-151-0/+172
View Lorry Controller Status