<p>Jonathan Neuschäfer has uploaded this change for <strong>review</strong>.</p><p><a href="https://review.coreboot.org/25787">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Documentation: Add support for building with Sphinx<br><br>This commit adds the necessary infrastructure to convert the Markdown<br>files in the Documentation directory to HTML using Sphinx[1] and<br>recommonmark[2]. I selected "sphinx_rtd_theme" as the theme, because it<br>offers a useful navigation sidebar, and because it's already used for<br>the Linux kernel[3].<br><br>Makefile.sphinx was auto-generated by sphinx-quickstart. conf.py was<br>auto-generated and manually adjusted.<br><br>[1]: http://www.sphinx-doc.org/en/stable/<br>[2]: https://recommonmark.readthedocs.io/en/latest/<br>[3]: https://www.kernel.org/doc/html/latest/index.html<br><br>Change-Id: Ie4de96978e334c598cf5890775807d3e15c29c4d<br>Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net><br>---<br>M .gitignore<br>M Documentation/Makefile<br>A Documentation/Makefile.sphinx<br>A Documentation/conf.py<br>A Documentation/index.md<br>5 files changed, 436 insertions(+), 1 deletion(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://review.coreboot.org:29418/coreboot refs/changes/87/25787/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/.gitignore b/.gitignore</span><br><span>index 7ee954d..378741f 100644</span><br><span>--- a/.gitignore</span><br><span>+++ b/.gitignore</span><br><span>@@ -132,5 +132,6 @@</span><br><span> documentation/mainboardkconfig.tex</span><br><span> documentation/skconfig.tex</span><br><span> documentation/socketfkconfig.tex</span><br><span style="color: hsl(120, 100%, 40%);">+Documentation/_build</span><br><span> </span><br><span> doxygen/*</span><br><span>diff --git a/Documentation/Makefile b/Documentation/Makefile</span><br><span>index ecfbdb4..b5f97d1 100644</span><br><span>--- a/Documentation/Makefile</span><br><span>+++ b/Documentation/Makefile</span><br><span>@@ -63,7 +63,13 @@</span><br><span>  grep '^config' $< | awk '{print $2}'  >>$@</span><br><span>  cat endverbatim.tex  >> $@</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-clean:</span><br><span style="color: hsl(120, 100%, 40%);">+sphinx:</span><br><span style="color: hsl(120, 100%, 40%);">+   $(MAKE) -f Makefile.sphinx html</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+clean-sphinx:</span><br><span style="color: hsl(120, 100%, 40%);">+      $(MAKE) -f Makefile.sphinx clean</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+clean: clean-sphinx</span><br><span>      rm -f *.aux *.idx *.log *.toc *.out $(FIGS) mainboardkconfig.tex skconfig.tex cpukconfig.tex socketfkconfig.tex</span><br><span> </span><br><span> distclean: clean</span><br><span>diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx</span><br><span>new file mode 100644</span><br><span>index 0000000..0ecebbe</span><br><span>--- /dev/null</span><br><span>+++ b/Documentation/Makefile.sphinx</span><br><span>@@ -0,0 +1,225 @@</span><br><span style="color: hsl(120, 100%, 40%);">+# Makefile for Sphinx documentation</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# You can set these variables from the command line.</span><br><span style="color: hsl(120, 100%, 40%);">+SPHINXOPTS    =</span><br><span style="color: hsl(120, 100%, 40%);">+SPHINXBUILD   = sphinx-build</span><br><span style="color: hsl(120, 100%, 40%);">+PAPER         =</span><br><span style="color: hsl(120, 100%, 40%);">+BUILDDIR      = _build</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# Internal variables.</span><br><span style="color: hsl(120, 100%, 40%);">+PAPEROPT_a4     = -D latex_paper_size=a4</span><br><span style="color: hsl(120, 100%, 40%);">+PAPEROPT_letter = -D latex_paper_size=letter</span><br><span style="color: hsl(120, 100%, 40%);">+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .</span><br><span style="color: hsl(120, 100%, 40%);">+# the i18n builder cannot share the environment and doctrees with the others</span><br><span style="color: hsl(120, 100%, 40%);">+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: help</span><br><span style="color: hsl(120, 100%, 40%);">+help:</span><br><span style="color: hsl(120, 100%, 40%);">+  @echo "Please use \`make <target>' where <target> is one of"</span><br><span style="color: hsl(120, 100%, 40%);">+        @echo "  html       to make standalone HTML files"</span><br><span style="color: hsl(120, 100%, 40%);">+  @echo "  dirhtml    to make HTML files named index.html in directories"</span><br><span style="color: hsl(120, 100%, 40%);">+     @echo "  singlehtml to make a single large HTML file"</span><br><span style="color: hsl(120, 100%, 40%);">+       @echo "  pickle     to make pickle files"</span><br><span style="color: hsl(120, 100%, 40%);">+   @echo "  json       to make JSON files"</span><br><span style="color: hsl(120, 100%, 40%);">+     @echo "  htmlhelp   to make HTML files and a HTML help project"</span><br><span style="color: hsl(120, 100%, 40%);">+     @echo "  qthelp     to make HTML files and a qthelp project"</span><br><span style="color: hsl(120, 100%, 40%);">+        @echo "  applehelp  to make an Apple Help Book"</span><br><span style="color: hsl(120, 100%, 40%);">+     @echo "  devhelp    to make HTML files and a Devhelp project"</span><br><span style="color: hsl(120, 100%, 40%);">+       @echo "  epub       to make an epub"</span><br><span style="color: hsl(120, 100%, 40%);">+        @echo "  epub3      to make an epub3"</span><br><span style="color: hsl(120, 100%, 40%);">+       @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"</span><br><span style="color: hsl(120, 100%, 40%);">+      @echo "  latexpdf   to make LaTeX files and run them through pdflatex"</span><br><span style="color: hsl(120, 100%, 40%);">+      @echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"</span><br><span style="color: hsl(120, 100%, 40%);">+       @echo "  text       to make text files"</span><br><span style="color: hsl(120, 100%, 40%);">+     @echo "  man        to make manual pages"</span><br><span style="color: hsl(120, 100%, 40%);">+   @echo "  texinfo    to make Texinfo files"</span><br><span style="color: hsl(120, 100%, 40%);">+  @echo "  info       to make Texinfo files and run them through makeinfo"</span><br><span style="color: hsl(120, 100%, 40%);">+    @echo "  gettext    to make PO message catalogs"</span><br><span style="color: hsl(120, 100%, 40%);">+    @echo "  changes    to make an overview of all changed/added/deprecated items"</span><br><span style="color: hsl(120, 100%, 40%);">+      @echo "  xml        to make Docutils-native XML files"</span><br><span style="color: hsl(120, 100%, 40%);">+      @echo "  pseudoxml  to make pseudoxml-XML files for display purposes"</span><br><span style="color: hsl(120, 100%, 40%);">+       @echo "  linkcheck  to check all external links for integrity"</span><br><span style="color: hsl(120, 100%, 40%);">+      @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "  coverage   to run coverage check of the documentation (if enabled)"</span><br><span style="color: hsl(120, 100%, 40%);">+        @echo "  dummy      to check syntax errors of document sources"</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: clean</span><br><span style="color: hsl(120, 100%, 40%);">+clean:</span><br><span style="color: hsl(120, 100%, 40%);">+    rm -rf $(BUILDDIR)/*</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: html</span><br><span style="color: hsl(120, 100%, 40%);">+html:</span><br><span style="color: hsl(120, 100%, 40%);">+   $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html</span><br><span style="color: hsl(120, 100%, 40%);">+      @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: dirhtml</span><br><span style="color: hsl(120, 100%, 40%);">+dirhtml:</span><br><span style="color: hsl(120, 100%, 40%);">+        $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml</span><br><span style="color: hsl(120, 100%, 40%);">+        @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: singlehtml</span><br><span style="color: hsl(120, 100%, 40%);">+singlehtml:</span><br><span style="color: hsl(120, 100%, 40%);">+       $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml</span><br><span style="color: hsl(120, 100%, 40%);">+  @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: pickle</span><br><span style="color: hsl(120, 100%, 40%);">+pickle:</span><br><span style="color: hsl(120, 100%, 40%);">+      $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle</span><br><span style="color: hsl(120, 100%, 40%);">+  @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished; now you can process the pickle files."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: json</span><br><span style="color: hsl(120, 100%, 40%);">+json:</span><br><span style="color: hsl(120, 100%, 40%);">+        $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json</span><br><span style="color: hsl(120, 100%, 40%);">+      @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished; now you can process the JSON files."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: htmlhelp</span><br><span style="color: hsl(120, 100%, 40%);">+htmlhelp:</span><br><span style="color: hsl(120, 100%, 40%);">+  $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp</span><br><span style="color: hsl(120, 100%, 40%);">+      @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished; now you can run HTML Help Workshop with the" \</span><br><span style="color: hsl(120, 100%, 40%);">+             ".hhp project file in $(BUILDDIR)/htmlhelp."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: qthelp</span><br><span style="color: hsl(120, 100%, 40%);">+qthelp:</span><br><span style="color: hsl(120, 100%, 40%);">+       $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp</span><br><span style="color: hsl(120, 100%, 40%);">+  @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \</span><br><span style="color: hsl(120, 100%, 40%);">+       ".qhcp project file in $(BUILDDIR)/qthelp, like this:"</span><br><span style="color: hsl(120, 100%, 40%);">+        @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/coreboot.qhcp"</span><br><span style="color: hsl(120, 100%, 40%);">+     @echo "To view the help file:"</span><br><span style="color: hsl(120, 100%, 40%);">+      @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/coreboot.qhc"</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: applehelp</span><br><span style="color: hsl(120, 100%, 40%);">+applehelp:</span><br><span style="color: hsl(120, 100%, 40%);">+        $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp</span><br><span style="color: hsl(120, 100%, 40%);">+    @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."</span><br><span style="color: hsl(120, 100%, 40%);">+  @echo "N.B. You won't be able to view it unless you put it in" \</span><br><span style="color: hsl(120, 100%, 40%);">+              "~/Library/Documentation/Help or install it in your application" \</span><br><span style="color: hsl(120, 100%, 40%);">+          "bundle."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: devhelp</span><br><span style="color: hsl(120, 100%, 40%);">+devhelp:</span><br><span style="color: hsl(120, 100%, 40%);">+        $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp</span><br><span style="color: hsl(120, 100%, 40%);">+        @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished."</span><br><span style="color: hsl(120, 100%, 40%);">+     @echo "To view the help file:"</span><br><span style="color: hsl(120, 100%, 40%);">+      @echo "# mkdir -p $$HOME/.local/share/devhelp/coreboot"</span><br><span style="color: hsl(120, 100%, 40%);">+     @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/coreboot"</span><br><span style="color: hsl(120, 100%, 40%);">+    @echo "# devhelp"</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: epub</span><br><span style="color: hsl(120, 100%, 40%);">+epub:</span><br><span style="color: hsl(120, 100%, 40%);">+    $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub</span><br><span style="color: hsl(120, 100%, 40%);">+      @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: epub3</span><br><span style="color: hsl(120, 100%, 40%);">+epub3:</span><br><span style="color: hsl(120, 100%, 40%);">+      $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3</span><br><span style="color: hsl(120, 100%, 40%);">+    @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: latex</span><br><span style="color: hsl(120, 100%, 40%);">+latex:</span><br><span style="color: hsl(120, 100%, 40%);">+    $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex</span><br><span style="color: hsl(120, 100%, 40%);">+    @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."</span><br><span style="color: hsl(120, 100%, 40%);">+   @echo "Run \`make' in that directory to run these through (pdf)latex" \</span><br><span style="color: hsl(120, 100%, 40%);">+       "(use \`make latexpdf' here to do that automatically)."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: latexpdf</span><br><span style="color: hsl(120, 100%, 40%);">+latexpdf:</span><br><span style="color: hsl(120, 100%, 40%);">+    $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex</span><br><span style="color: hsl(120, 100%, 40%);">+    @echo "Running LaTeX files through pdflatex..."</span><br><span style="color: hsl(120, 100%, 40%);">+     $(MAKE) -C $(BUILDDIR)/latex all-pdf</span><br><span style="color: hsl(120, 100%, 40%);">+  @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: latexpdfja</span><br><span style="color: hsl(120, 100%, 40%);">+latexpdfja:</span><br><span style="color: hsl(120, 100%, 40%);">+       $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex</span><br><span style="color: hsl(120, 100%, 40%);">+    @echo "Running LaTeX files through platex and dvipdfmx..."</span><br><span style="color: hsl(120, 100%, 40%);">+  $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja</span><br><span style="color: hsl(120, 100%, 40%);">+       @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: text</span><br><span style="color: hsl(120, 100%, 40%);">+text:</span><br><span style="color: hsl(120, 100%, 40%);">+   $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text</span><br><span style="color: hsl(120, 100%, 40%);">+      @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished. The text files are in $(BUILDDIR)/text."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: man</span><br><span style="color: hsl(120, 100%, 40%);">+man:</span><br><span style="color: hsl(120, 100%, 40%);">+        $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man</span><br><span style="color: hsl(120, 100%, 40%);">+        @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: texinfo</span><br><span style="color: hsl(120, 100%, 40%);">+texinfo:</span><br><span style="color: hsl(120, 100%, 40%);">+       $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo</span><br><span style="color: hsl(120, 100%, 40%);">+        @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."</span><br><span style="color: hsl(120, 100%, 40%);">+       @echo "Run \`make' in that directory to run these through makeinfo" \</span><br><span style="color: hsl(120, 100%, 40%);">+         "(use \`make info' here to do that automatically)."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: info</span><br><span style="color: hsl(120, 100%, 40%);">+info:</span><br><span style="color: hsl(120, 100%, 40%);">+        $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo</span><br><span style="color: hsl(120, 100%, 40%);">+        @echo "Running Texinfo files through makeinfo..."</span><br><span style="color: hsl(120, 100%, 40%);">+   make -C $(BUILDDIR)/texinfo info</span><br><span style="color: hsl(120, 100%, 40%);">+      @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: gettext</span><br><span style="color: hsl(120, 100%, 40%);">+gettext:</span><br><span style="color: hsl(120, 100%, 40%);">+  $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale</span><br><span style="color: hsl(120, 100%, 40%);">+        @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: changes</span><br><span style="color: hsl(120, 100%, 40%);">+changes:</span><br><span style="color: hsl(120, 100%, 40%);">+        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes</span><br><span style="color: hsl(120, 100%, 40%);">+        @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "The overview file is in $(BUILDDIR)/changes."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: linkcheck</span><br><span style="color: hsl(120, 100%, 40%);">+linkcheck:</span><br><span style="color: hsl(120, 100%, 40%);">+       $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck</span><br><span style="color: hsl(120, 100%, 40%);">+    @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Link check complete; look for any errors in the above output " \</span><br><span style="color: hsl(120, 100%, 40%);">+           "or in $(BUILDDIR)/linkcheck/output.txt."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: doctest</span><br><span style="color: hsl(120, 100%, 40%);">+doctest:</span><br><span style="color: hsl(120, 100%, 40%);">+        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest</span><br><span style="color: hsl(120, 100%, 40%);">+        @echo "Testing of doctests in the sources finished, look at the " \</span><br><span style="color: hsl(120, 100%, 40%);">+       "results in $(BUILDDIR)/doctest/output.txt."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: coverage</span><br><span style="color: hsl(120, 100%, 40%);">+coverage:</span><br><span style="color: hsl(120, 100%, 40%);">+   $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage</span><br><span style="color: hsl(120, 100%, 40%);">+      @echo "Testing of coverage in the sources finished, look at the " \</span><br><span style="color: hsl(120, 100%, 40%);">+       "results in $(BUILDDIR)/coverage/python.txt."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: xml</span><br><span style="color: hsl(120, 100%, 40%);">+xml:</span><br><span style="color: hsl(120, 100%, 40%);">+    $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml</span><br><span style="color: hsl(120, 100%, 40%);">+        @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: pseudoxml</span><br><span style="color: hsl(120, 100%, 40%);">+pseudoxml:</span><br><span style="color: hsl(120, 100%, 40%);">+      $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml</span><br><span style="color: hsl(120, 100%, 40%);">+    @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.PHONY: dummy</span><br><span style="color: hsl(120, 100%, 40%);">+dummy:</span><br><span style="color: hsl(120, 100%, 40%);">+ $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy</span><br><span style="color: hsl(120, 100%, 40%);">+    @echo</span><br><span style="color: hsl(120, 100%, 40%);">+ @echo "Build finished. Dummy builder generates no files."</span><br><span>diff --git a/Documentation/conf.py b/Documentation/conf.py</span><br><span>new file mode 100644</span><br><span>index 0000000..e893772</span><br><span>--- /dev/null</span><br><span>+++ b/Documentation/conf.py</span><br><span>@@ -0,0 +1,182 @@</span><br><span style="color: hsl(120, 100%, 40%);">+# -*- coding: utf-8 -*-</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# Add any paths that contain templates here, relative to this directory.</span><br><span style="color: hsl(120, 100%, 40%);">+templates_path = ['_templates']</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# The suffix(es) of source filenames.</span><br><span style="color: hsl(120, 100%, 40%);">+source_suffix = ['.md']</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# The master toctree document.</span><br><span style="color: hsl(120, 100%, 40%);">+master_doc = 'index'</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# General information about the project.</span><br><span style="color: hsl(120, 100%, 40%);">+project = u'coreboot'</span><br><span style="color: hsl(120, 100%, 40%);">+copyright = u'the coreboot project'</span><br><span style="color: hsl(120, 100%, 40%);">+author = u'the coreboot project'</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# The version info for the project you're documenting, acts as replacement for</span><br><span style="color: hsl(120, 100%, 40%);">+# |version| and |release|, also used in various other places throughout the</span><br><span style="color: hsl(120, 100%, 40%);">+# built documents.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# The short X.Y version.</span><br><span style="color: hsl(120, 100%, 40%);">+version = u'4.7'</span><br><span style="color: hsl(120, 100%, 40%);">+# The full version, including alpha/beta/rc tags.</span><br><span style="color: hsl(120, 100%, 40%);">+release = u'4.7' # TODO: use 'git describe'</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# The language for content autogenerated by Sphinx. Refer to documentation</span><br><span style="color: hsl(120, 100%, 40%);">+# for a list of supported languages.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# This is also used if you do content translation via gettext catalogs.</span><br><span style="color: hsl(120, 100%, 40%);">+# Usually you set "language" from the command line for these cases.</span><br><span style="color: hsl(120, 100%, 40%);">+language = None</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# List of patterns, relative to source directory, that match files and</span><br><span style="color: hsl(120, 100%, 40%);">+# directories to ignore when looking for source files.</span><br><span style="color: hsl(120, 100%, 40%);">+# This patterns also effect to html_static_path and html_extra_path</span><br><span style="color: hsl(120, 100%, 40%);">+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# The name of the Pygments (syntax highlighting) style to use.</span><br><span style="color: hsl(120, 100%, 40%);">+pygments_style = 'sphinx'</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# A list of ignored prefixes for module index sorting.</span><br><span style="color: hsl(120, 100%, 40%);">+# modindex_common_prefix = []</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# If true, keep warnings as "system message" paragraphs in the built documents.</span><br><span style="color: hsl(120, 100%, 40%);">+# keep_warnings = False</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# If true, `todo` and `todoList` produce output, else they produce nothing.</span><br><span style="color: hsl(120, 100%, 40%);">+todo_include_todos = False</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# -- Options for HTML output ----------------------------------------------</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# The theme to use for HTML and HTML Help pages.  See the documentation for</span><br><span style="color: hsl(120, 100%, 40%);">+# a list of builtin themes.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+html_theme = 'sphinx_rtd_theme'</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# Add any paths that contain custom static files (such as style sheets) here,</span><br><span style="color: hsl(120, 100%, 40%);">+# relative to this directory. They are copied after the builtin static files,</span><br><span style="color: hsl(120, 100%, 40%);">+# so a file named "default.css" will overwrite the builtin "default.css".</span><br><span style="color: hsl(120, 100%, 40%);">+#html_static_path = ['_static']</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# Output file base name for HTML help builder.</span><br><span style="color: hsl(120, 100%, 40%);">+htmlhelp_basename = 'corebootdoc'</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# -- Options for LaTeX output ---------------------------------------------</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+latex_elements = {</span><br><span style="color: hsl(120, 100%, 40%);">+     # The paper size ('letterpaper' or 'a4paper').</span><br><span style="color: hsl(120, 100%, 40%);">+     #</span><br><span style="color: hsl(120, 100%, 40%);">+     # 'papersize': 'letterpaper',</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+     # The font size ('10pt', '11pt' or '12pt').</span><br><span style="color: hsl(120, 100%, 40%);">+     #</span><br><span style="color: hsl(120, 100%, 40%);">+     # 'pointsize': '10pt',</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+     # Additional stuff for the LaTeX preamble.</span><br><span style="color: hsl(120, 100%, 40%);">+     #</span><br><span style="color: hsl(120, 100%, 40%);">+     # 'preamble': '',</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+     # Latex figure (float) alignment</span><br><span style="color: hsl(120, 100%, 40%);">+     #</span><br><span style="color: hsl(120, 100%, 40%);">+     # 'figure_align': 'htbp',</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# Grouping the document tree into LaTeX files. List of tuples</span><br><span style="color: hsl(120, 100%, 40%);">+# (source start file, target name, title,</span><br><span style="color: hsl(120, 100%, 40%);">+#  author, documentclass [howto, manual, or own class]).</span><br><span style="color: hsl(120, 100%, 40%);">+latex_documents = [</span><br><span style="color: hsl(120, 100%, 40%);">+    (master_doc, 'coreboot.tex', u'coreboot Documentation',</span><br><span style="color: hsl(120, 100%, 40%);">+     u'the coreboot project', 'manual'),</span><br><span style="color: hsl(120, 100%, 40%);">+]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# The name of an image file (relative to this directory) to place at the top of</span><br><span style="color: hsl(120, 100%, 40%);">+# the title page.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# latex_logo = None</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# For "manual" documents, if this is true, then toplevel headings are parts,</span><br><span style="color: hsl(120, 100%, 40%);">+# not chapters.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# latex_use_parts = False</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# If true, show page references after internal links.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# latex_show_pagerefs = False</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# If true, show URL addresses after external links.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# latex_show_urls = False</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# Documents to append as an appendix to all manuals.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# latex_appendices = []</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# It false, will not define \strong, \code,    itleref, \crossref ... but only</span><br><span style="color: hsl(120, 100%, 40%);">+# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added</span><br><span style="color: hsl(120, 100%, 40%);">+# packages.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# latex_keep_old_macro_names = True</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# If false, no module index is generated.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# latex_domain_indices = True</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# -- Options for manual page output ---------------------------------------</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# One entry per manual page. List of tuples</span><br><span style="color: hsl(120, 100%, 40%);">+# (source start file, name, description, authors, manual section).</span><br><span style="color: hsl(120, 100%, 40%);">+man_pages = [</span><br><span style="color: hsl(120, 100%, 40%);">+    (master_doc, 'coreboot', u'coreboot Documentation',</span><br><span style="color: hsl(120, 100%, 40%);">+     [author], 1)</span><br><span style="color: hsl(120, 100%, 40%);">+]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# If true, show URL addresses after external links.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# man_show_urls = False</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# -- Options for Texinfo output -------------------------------------------</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# Grouping the document tree into Texinfo files. List of tuples</span><br><span style="color: hsl(120, 100%, 40%);">+# (source start file, target name, title, author,</span><br><span style="color: hsl(120, 100%, 40%);">+#  dir menu entry, description, category)</span><br><span style="color: hsl(120, 100%, 40%);">+texinfo_documents = [</span><br><span style="color: hsl(120, 100%, 40%);">+    (master_doc, 'coreboot', u'coreboot Documentation',</span><br><span style="color: hsl(120, 100%, 40%);">+     author, 'coreboot', 'One line description of project.',</span><br><span style="color: hsl(120, 100%, 40%);">+     'Miscellaneous'),</span><br><span style="color: hsl(120, 100%, 40%);">+]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+source_parsers = {</span><br><span style="color: hsl(120, 100%, 40%);">+    '.md': 'recommonmark.parser.CommonMarkParser',</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# Documents to append as an appendix to all manuals.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# texinfo_appendices = []</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# If false, no module index is generated.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# texinfo_domain_indices = True</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# How to display URL addresses: 'footnote', 'no', or 'inline'.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# texinfo_show_urls = 'footnote'</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# If true, do not generate a @detailmenu in the "Top" node's menu.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# texinfo_no_detailmenu = False</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+enable_auto_toc_tree = True</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+def setup(app):</span><br><span style="color: hsl(120, 100%, 40%);">+    from recommonmark.transform import AutoStructify</span><br><span style="color: hsl(120, 100%, 40%);">+    app.add_config_value('recommonmark_config', {</span><br><span style="color: hsl(120, 100%, 40%);">+        'enable_auto_toc_tree': True,</span><br><span style="color: hsl(120, 100%, 40%);">+        'enable_auto_doc_ref': True,</span><br><span style="color: hsl(120, 100%, 40%);">+        'url_resolver': lambda url: '/' + url</span><br><span style="color: hsl(120, 100%, 40%);">+    }, True)</span><br><span style="color: hsl(120, 100%, 40%);">+    app.add_transform(AutoStructify)</span><br><span>diff --git a/Documentation/index.md b/Documentation/index.md</span><br><span>new file mode 100644</span><br><span>index 0000000..8354786</span><br><span>--- /dev/null</span><br><span>+++ b/Documentation/index.md</span><br><span>@@ -0,0 +1,21 @@</span><br><span style="color: hsl(120, 100%, 40%);">+Welcome to coreboot's documentation!</span><br><span style="color: hsl(120, 100%, 40%);">+====================================</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+This is the developer documentation for [coreboot](https://coreboot.org).</span><br><span style="color: hsl(120, 100%, 40%);">+It is built from Markdown files in the</span><br><span style="color: hsl(120, 100%, 40%);">+[Documentation](https://review.coreboot.org/cgit/coreboot.git/tree/Documentation)</span><br><span style="color: hsl(120, 100%, 40%);">+directory in the source code.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Contents:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+* [Lesson 2: Submitting a patch to coreboot.org](Lesson2.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [Gerrit Etiquette and Guidelines](gerrit_guidelines.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [coreboot's build system](build_system.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [Kconfig in coreboot](core/Kconfig.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [Use of git submodules in coreboot](submodules.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [Timestamps](timestamp.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [Dealing with Untrusted Input in SMM](technotes/2017-02-dealing-with-untrusted-input-in-smm.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [ABI data consumption](abi-data-consumption.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [GPIO toggling in ACPI AML](acpi/gpio.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [Native Graphics Initialization with libgfxinit](gfx/libgfxinit.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [Sandy Bridge Raminit](Intel/NativeRaminit/Sandybridge.md)</span><br><span></span><br></pre><p>To view, visit <a href="https://review.coreboot.org/25787">change 25787</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://review.coreboot.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://review.coreboot.org/25787"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: coreboot </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>
<div style="display:none"> Gerrit-Change-Id: Ie4de96978e334c598cf5890775807d3e15c29c4d </div>
<div style="display:none"> Gerrit-Change-Number: 25787 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Jonathan Neuschäfer <j.neuschaefer@gmx.net> </div>