Rewrite documentation to Sphinx.
This commit is contained in:
Daniel Mach
parent
81e935fe0e
commit
a3d46f5393
1
.gitignore
vendored
1
.gitignore
vendored
@ -3,6 +3,7 @@
|
||||
MANIFEST
|
||||
build/*
|
||||
dist/*
|
||||
doc/_build
|
||||
noarch/*
|
||||
tests/data/repo
|
||||
tests/data/repo-krb5-lookaside
|
||||
|
||||
7
Makefile
7
Makefile
@ -1,3 +1,5 @@
|
||||
.PHONY: all clean doc log test
|
||||
|
||||
PKGNAME=pungi
|
||||
VERSION=$(shell rpm -q --qf "%{VERSION}\n" --specfile ${PKGNAME}.spec)
|
||||
RELEASE=$(shell rpm -q --qf "%{RELEASE}\n" --specfile ${PKGNAME}.spec)
|
||||
@ -17,6 +19,7 @@ help:
|
||||
@echo "Available targets are:"
|
||||
@echo " help show this text"
|
||||
@echo " clean remove python bytecode and temp files"
|
||||
@echo " doc build documentation"
|
||||
@echo " install install program on current system"
|
||||
@echo " test-data build test data (requirement for running tests)"
|
||||
@echo " test run tests"
|
||||
@ -94,3 +97,7 @@ test:
|
||||
|
||||
test-data:
|
||||
./tests/data/specs/build.sh
|
||||
|
||||
|
||||
doc:
|
||||
cd doc; make html
|
||||
|
||||
177
doc/Makefile
Normal file
177
doc/Makefile
Normal file
@ -0,0 +1,177 @@
|
||||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = _build
|
||||
|
||||
# User-friendly check for sphinx-build
|
||||
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
||||
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
|
||||
endif
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
||||
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " xml to make Docutils-native XML files"
|
||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
|
||||
clean:
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Pungi.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Pungi.qhc"
|
||||
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/Pungi"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Pungi"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
latexpdfja:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
texinfo:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
info:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
xml:
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
pseudoxml:
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
@ -1,7 +0,0 @@
|
||||
Pungi
|
||||
An anaconda based installation spin tool
|
||||
|
||||
This project is aimed at making a public / free tool to spin installation
|
||||
trees/isos of Fedora and Fedora based distributions.
|
||||
|
||||
See http://hosted.fedoraproject.org/projects/pungi for more information.
|
||||
0
doc/_static/.keep
vendored
Normal file
0
doc/_static/.keep
vendored
Normal file
0
doc/_templates/.keep
vendored
Normal file
0
doc/_templates/.keep
vendored
Normal file
24
doc/about.rst
Normal file
24
doc/about.rst
Normal file
@ -0,0 +1,24 @@
|
||||
=============
|
||||
About Pungi
|
||||
=============
|
||||
|
||||
Pungi is a distribution compose tool.
|
||||
|
||||
Composes are release snapshots that contain release deliverables such as:
|
||||
|
||||
- installation trees
|
||||
|
||||
- RPMs
|
||||
- repodata
|
||||
- comps
|
||||
|
||||
- (bootable) ISOs
|
||||
- kickstart trees
|
||||
|
||||
- anaconda images
|
||||
- images for PXE boot
|
||||
|
||||
|
||||
Links
|
||||
=====
|
||||
- Upstream GIT: https://pagure.io/pungi/
|
||||
258
doc/conf.py
Normal file
258
doc/conf.py
Normal file
@ -0,0 +1,258 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Pungi documentation build configuration file, created by
|
||||
# sphinx-quickstart on Thu Jul 2 08:11:04 2015.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import sys
|
||||
import os
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = []
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'Pungi'
|
||||
copyright = u'2015, Red Hat, Inc.'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '4.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '4.0'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#today = ''
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = ['_build']
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
#default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
#modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
#keep_warnings = False
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'default'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
#html_title = None
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#html_logo = None
|
||||
|
||||
# The name of an image file (within the static path) to use as favicon of the
|
||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
# directly to the root of the documentation.
|
||||
#html_extra_path = []
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
#html_last_updated_fmt = '%b %d, %Y'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'Pungidoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#'preamble': '',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
('index', 'Pungi.tex', u'Pungi Documentation',
|
||||
u'Daniel Mach', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#latex_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'pungi', u'Pungi Documentation',
|
||||
[u'Daniel Mach'], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', 'Pungi', u'Pungi Documentation',
|
||||
u'Daniel Mach', 'Pungi', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
#texinfo_no_detailmenu = False
|
||||
88
doc/contributing.rst
Normal file
88
doc/contributing.rst
Normal file
@ -0,0 +1,88 @@
|
||||
=====================
|
||||
Contributing to Pungi
|
||||
=====================
|
||||
|
||||
|
||||
Developing
|
||||
==========
|
||||
|
||||
Currently the development workflow for Pungi is on master branch:
|
||||
|
||||
- Make your own fork at https://pagure.io/pungi
|
||||
- Clone your fork locally (replacing $USERNAME with your own)::
|
||||
|
||||
git clone git@pagure.io:forks/$USERNAME/pungi.git
|
||||
|
||||
- cd into your local clone and add the remote upstream for rebasing::
|
||||
|
||||
cd pungi
|
||||
git remote add upstream git@pagure.io:pungi.git
|
||||
|
||||
# NOTE: This workflow assumes that you never 'git commit' directly to
|
||||
# the master branch of your fork. This will make more sense when we
|
||||
# cover rebasing below.
|
||||
|
||||
- create a topic branch based on master::
|
||||
|
||||
git branch my_topic_branch master
|
||||
git checkout my_topic_branch
|
||||
|
||||
|
||||
- Make edits, changes, add new features, etc. and then make sure to pull
|
||||
from upstream master and rebase before submitting a pull request::
|
||||
|
||||
# lets just say you edited setup.py for sake of argument
|
||||
git checkout my_topic_branch
|
||||
|
||||
# make changes to setup.py
|
||||
git add setup.py
|
||||
git commit -m "added awesome feature to setup.py"
|
||||
|
||||
# now we rebase
|
||||
git checkout master
|
||||
git fetch upstream
|
||||
git fetch upstream --tags
|
||||
git merge upstream/master
|
||||
git push origin master
|
||||
git push origin --tags
|
||||
git checkout my_topic_branch
|
||||
git rebase master
|
||||
|
||||
# resolve merge conflicts if any as a result of your development in
|
||||
# your topic branch
|
||||
git push origin my_topic_branch
|
||||
|
||||
- Create pull request in the pagure.io web UI
|
||||
|
||||
- For convenience, here is a bash shell function that can be placed in your
|
||||
~/.bashrc and called such as 'pullupstream pungi-4-devel' that will
|
||||
automate a large portion of the rebase steps from above::
|
||||
|
||||
pullupstream () {
|
||||
if [[ -z "$1" ]]; then
|
||||
printf "Error: must specify a branch name (e.g. - master, devel)\n"
|
||||
else
|
||||
pullup_startbranch=$(git describe --contains --all HEAD)
|
||||
git checkout $1
|
||||
git fetch upstream
|
||||
git fetch upstream --tags
|
||||
git merge upstream/$1
|
||||
git push origin $1
|
||||
git push origin --tags
|
||||
git checkout ${pullup_startbranch}
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
Testing
|
||||
=======
|
||||
|
||||
You must write unit tests for any code but trivial changes.
|
||||
Any code without sufficient test coverage may not be merged.
|
||||
|
||||
|
||||
Documenting
|
||||
===========
|
||||
|
||||
You must write documentation for any new features and functional changes.
|
||||
Any code without sufficient documentation may not be merged.
|
||||
@ -1,82 +0,0 @@
|
||||
##############################################################################
|
||||
# Developing
|
||||
|
||||
Currently the development workflow for pungi 4 is on master:
|
||||
|
||||
- Make your own fork at https://pagure.io/pungi
|
||||
|
||||
- Clone your fork locally (replacing $USERNAME with your own):
|
||||
git clone git@pagure.io:forks/$USERNAME/pungi.git
|
||||
|
||||
- cd into your local clone and add the remote upstream for rebasing:
|
||||
cd pungi
|
||||
git remote add upstream git@pagure.io:pungi.git
|
||||
|
||||
#NOTE: This workflow assumes that you never 'git commit' directly to
|
||||
# the master branch of your fork. This will make more sense
|
||||
# when we cover rebasing below.
|
||||
|
||||
- create a topic branch based on master
|
||||
git branch my_topic_branch master
|
||||
git checkout my_topic_branch
|
||||
|
||||
- Make edits, changes, add new features, etc. and then make sure to pull
|
||||
from upstream master and rebase before submitting a pull request.
|
||||
## lets just say you edited setup.py for sake of argument
|
||||
git checkout my_topic_branch
|
||||
# make changes to setup.py
|
||||
git add setup.py
|
||||
git commit -m "added awesome feature to setup.py"
|
||||
|
||||
## Now we rebase
|
||||
git checkout master
|
||||
git fetch upstream
|
||||
git fetch upstream --tags
|
||||
git merge upstream/master
|
||||
git push origin master
|
||||
git push origin --tags
|
||||
git checkout my_topic_branch
|
||||
git rebase master
|
||||
# Resolve merge conflicts if any as a result of your development in
|
||||
# your topic branch
|
||||
git push origin my_topic_branch
|
||||
|
||||
- Create pull request in the pagure.io web UI
|
||||
|
||||
- For convenience, here is a bash shell function that can be placed in your
|
||||
~/.bashrc and called such as 'pullupstream pungi-4-devel' that will
|
||||
automate a large portion of the rebase steps from above.
|
||||
|
||||
pullupstream () {
|
||||
if [[ -z "$1" ]]; then
|
||||
printf "Error: must specify a branch name (e.g. - master, devel)\n"
|
||||
else
|
||||
pullup_startbranch=$(git describe --contains --all HEAD)
|
||||
git checkout $1
|
||||
git fetch upstream
|
||||
git fetch upstream --tags
|
||||
git merge upstream/$1
|
||||
git push origin $1
|
||||
git push origin --tags
|
||||
git checkout ${pullup_startbranch}
|
||||
fi
|
||||
}
|
||||
|
||||
##############################################################################
|
||||
# Testing
|
||||
|
||||
Unit tests
|
||||
- Unit tests are encouraged and should be placed in the tests/ directory
|
||||
within the pungi git repository
|
||||
|
||||
Running pungi locally for testing
|
||||
- Running pungi locally for testing, you should build the rpm, install it,
|
||||
and run ''pungi-koji' as follows:
|
||||
|
||||
pungi-koji --target-dir=/path/to/store/compose/ --nightly \
|
||||
--config=/path/to/pungi-fedora/fedora.conf
|
||||
|
||||
The fedora.conf file and other files it references can be found here:
|
||||
https://pagure.io/pungi-fedora
|
||||
- These can either be copied down locally or you can git clone that
|
||||
repository as well to keep with the latest configurations.
|
||||
25
doc/index.rst
Normal file
25
doc/index.rst
Normal file
@ -0,0 +1,25 @@
|
||||
.. Pungi documentation master file, created by
|
||||
sphinx-quickstart on Thu Jul 2 08:11:04 2015.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to Pungi's documentation!
|
||||
=================================
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
about
|
||||
contributing
|
||||
testing
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
73
doc/pungi.8
73
doc/pungi.8
@ -1,73 +0,0 @@
|
||||
.\" pungi - anaconda-based installation spin tool
|
||||
.TH "pungi" "8" "Fedora Project" "Jesse Keating" ""
|
||||
.SH "NAME"
|
||||
pungi \- anaconda-based installation spin tool
|
||||
.SH "SYNOPSIS"
|
||||
\fBpungi\fP [options]
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
\fBpungi\fP is a tool to create anaconda-based installation trees or media images given a set of RPM packages.
|
||||
|
||||
.SH "OPTIONS"
|
||||
\fBpungi\fP is entirely command line oriented. All input to the program is given by command line options\&.
|
||||
.PP
|
||||
.IP "\fB\-h, \-\-help\fP"
|
||||
Display a help message and then quit\&.
|
||||
.IP "\fB\-\-version\fP"
|
||||
Display program's version number and then quit\&.
|
||||
.IP "\fB\-\-name=string\fP"
|
||||
Set the name for your distribution (defaults to "Fedora")\&.
|
||||
.IP "\fB\-\-ver=string\fP"
|
||||
Set the version for your distribution (defaults to datestamp, used for $releasever in yum)\&.
|
||||
.IP "\fB\-\-flavor=string\fP"
|
||||
Set the flavor of your spin (optional)\&.
|
||||
.IP "\fB\-\-destdir=pathspec\fP"
|
||||
Path specifying the destination directory (defaults to current directory)\&.
|
||||
.IP "\fB\-\-cachedir=pathspec\fP"
|
||||
Package cache directory (defaults to /var/cache/pungi)\&.
|
||||
.IP "\fB\-\-bugurl=urlspec\fP"
|
||||
The URL for your bug reporting system (defaults to http://bugzilla.redhat.com)\&.
|
||||
.IP "\fB\-\-discs=integer\fP"
|
||||
The number of discs you want to create (defaults to 1)\&.
|
||||
.IP "\fB\-\-nosource\fP"
|
||||
Disable gathering of source packages (optional)\&.
|
||||
.IP "\fB\-\-sourceisos\fP"
|
||||
Create the source media images (other arch runs must be done)\&.
|
||||
.IP "\fB\-\-force\fP"
|
||||
Force reuse of an existing destination directory (will overwrite files)\&.
|
||||
.IP "\fB\-c ksfile, \-\-config=ksfile\fP"
|
||||
Path to kickstart configuration file\&.
|
||||
.IP "\fB\-\-all\-stages\fP"
|
||||
Enable ALL stages\&.
|
||||
.IP "\fB\-G\fP"
|
||||
Enable the Gather stage\&.
|
||||
.IP "\fB\-C\fP"
|
||||
Enable the Createrepo stage\&.
|
||||
.IP "\fB\-B\fP"
|
||||
Enable the BuildInstall stage\&.
|
||||
.IP "\fB\-I\fP"
|
||||
Enable the CreateISO stage\&.
|
||||
|
||||
.PP
|
||||
.SH "EXAMPLES"
|
||||
.nf
|
||||
pungi -c /usr/share/pungi/f8-fedora.ks --destdir=/data/Fedora8 --name Fedora --ver 8
|
||||
.fi
|
||||
|
||||
.PP
|
||||
.SH "SEE ALSO"
|
||||
.nf
|
||||
http://fedoraproject.org/wiki/Releases/FeatureUsePungi
|
||||
https://hosted.fedoraproject.org/projects/pungi/
|
||||
.fi
|
||||
|
||||
.PP
|
||||
.SH "AUTHORS"
|
||||
.nf
|
||||
See the Authors file included with this program.
|
||||
.fi
|
||||
|
||||
.PP
|
||||
.SH "BUGS"
|
||||
No bugs were harmed in the making of this software.
|
||||
.fi
|
||||
@ -6,9 +6,9 @@
|
||||
Test Data
|
||||
=========
|
||||
Tests require test data and not all of it is available in git.
|
||||
You must create test repositories before running the tests:
|
||||
You must create test repositories before running the tests::
|
||||
|
||||
$ make test-data
|
||||
make test-data
|
||||
|
||||
Requirements: createrepo_c, rpmbuild
|
||||
|
||||
@ -16,19 +16,19 @@ Requirements: createrepo_c, rpmbuild
|
||||
Unit Tests
|
||||
==========
|
||||
Unit tests cover functionality of Pungi python modules.
|
||||
You can run all of them at once:
|
||||
You can run all of them at once::
|
||||
|
||||
$ make test
|
||||
make test
|
||||
|
||||
which is shortcut to:
|
||||
which is shortcut to::
|
||||
|
||||
$ python2 setup.py test
|
||||
$ python3 setup.py test
|
||||
python2 setup.py test
|
||||
python3 setup.py test
|
||||
|
||||
You can alternatively run individual tests:
|
||||
You can alternatively run individual tests::
|
||||
|
||||
$ cd tests
|
||||
$ ./<test>.py [<class>[.<test>]]
|
||||
cd tests
|
||||
./<test>.py [<class>[.<test>]]
|
||||
|
||||
|
||||
Functional Tests
|
||||
@ -36,7 +36,7 @@ Functional Tests
|
||||
Because compose is quite complex process and not everything is covered with
|
||||
unit tests yet, the easiest way how to test if your changes did not break
|
||||
anything badly is to start a compose on a relatively small and well defined
|
||||
package set:
|
||||
package set::
|
||||
|
||||
$ cd tests
|
||||
$ ./test_compose.sh
|
||||
cd tests
|
||||
./test_compose.sh
|
||||
Loading…
Reference in New Issue
Block a user