[hamradio-commits] [hamradio-maintguide] 01/01: Initial commit
Iain R. Learmonth
irl at moszumanska.debian.org
Thu Aug 27 14:02:03 UTC 2015
This is an automated email from the git hooks/post-receive script.
irl pushed a commit to branch master
in repository hamradio-maintguide.
commit 5a35b6c56b8fd35d0cf46003a12a7edef197218f
Author: Iain R. Learmonth <irl at debian.org>
Date: Wed Aug 26 22:27:35 2015 +0100
Initial commit
---
Makefile | 177 ++++++++++++++++++++++++
conf.py | 261 ++++++++++++++++++++++++++++++++++++
debian/changelog | 5 +
debian/compat | 1 +
debian/control | 20 +++
debian/copyright | 31 +++++
debian/doc-base.hamradio-maintguide | 14 ++
debian/hamradio-maintguide.docs | 2 +
debian/links | 2 +
debian/rules | 10 ++
debian/source/format | 1 +
index.rst | 50 +++++++
intro.rst | 49 +++++++
packaging.rst | 166 +++++++++++++++++++++++
qa.rst | 47 +++++++
vcs.rst | 254 +++++++++++++++++++++++++++++++++++
16 files changed, 1090 insertions(+)
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..c23de97
--- /dev/null
+++ b/Makefile
@@ -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/DebianHamradio.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DebianHamradio.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/DebianHamradio"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/DebianHamradio"
+ @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."
diff --git a/conf.py b/conf.py
new file mode 100644
index 0000000..0fb410b
--- /dev/null
+++ b/conf.py
@@ -0,0 +1,261 @@
+# -*- coding: utf-8 -*-
+#
+# Debian Hamradio documentation build configuration file, created by
+# sphinx-quickstart on Wed May 6 18:56:05 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 = [
+ 'sphinx.ext.todo',
+ 'sphinx.ext.pngmath',
+]
+
+# 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'Debian Hamradio Maintainers Guide'
+copyright = u'2015, Debian Hamradio Maintainers'
+
+# 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 = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# 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 = False
+
+# 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 = 'DebianHamradiodoc'
+
+
+# -- 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', 'DebianHamradio.tex', u'Debian Hamradio Maintainers Guide',
+ u'Debian Hamradio Maintainers', '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', 'debianhamradio', u'Debian Hamradio Maintainers Guide',
+ [u'Debian Hamradio Maintainers'], 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', 'DebianHamradio', u'Debian Hamradio Maintainers Guide',
+ u'Debian Hamradio Maintainers', 'DebianHamradio', '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
diff --git a/debian/changelog b/debian/changelog
new file mode 100644
index 0000000..b03ad85
--- /dev/null
+++ b/debian/changelog
@@ -0,0 +1,5 @@
+hamradio-maintguide (0.1) unstable; urgency=medium
+
+ * Initial release. (Closes: #796969)
+
+ -- Iain R. Learmonth <irl at debian.org> Thu, 27 Aug 2015 14:45:30 +0100
diff --git a/debian/compat b/debian/compat
new file mode 100644
index 0000000..ec63514
--- /dev/null
+++ b/debian/compat
@@ -0,0 +1 @@
+9
diff --git a/debian/control b/debian/control
new file mode 100644
index 0000000..70e8973
--- /dev/null
+++ b/debian/control
@@ -0,0 +1,20 @@
+Source: hamradio-maintguide
+Maintainer: Debian Hamradio Maintainers <debian-hams at lists.debian.org>
+Uploaders: Iain R. Learmonth <irl at debian.org>
+Section: doc
+Priority: optional
+Build-Depends: debhelper (>= 9), python3-sphinx | python-sphinx, texlive-latex-recommended, texlive-latex-extra, texlive-fonts-recommended
+Standards-Version: 3.9.6
+Vcs-Browser: http://anonscm.debian.org/cgit/pkg-hamradio/hamradio-maintguide.git
+Vcs-Git: http://anonscm.debian.org/git/pkg-hamradio/hamradio-maintguide.git
+
+Package: hamradio-maintguide
+Architecture: all
+Depends: ${misc:Depends},
+ libjs-jquery,
+ libjs-underscore
+Description: Debian Hamradio Maintainers Guide
+ The Debian Hamradio Maintainers Guide is a document that outlines team policy
+ and best current practice for the Deian Hamradio Maintainers packaging team.
+ .
+ The documentation is installed in both HTML and PDF format.
diff --git a/debian/copyright b/debian/copyright
new file mode 100644
index 0000000..09142f2
--- /dev/null
+++ b/debian/copyright
@@ -0,0 +1,31 @@
+Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: hamradio-maintguide
+
+Files: *
+Copyright:
+ (C) 2015 Iain R. Learmonth <irl at debian.org>
+License: BSD-2-clause
+
+License: BSD-2-clause
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+ .
+ 1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ .
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ .
+ THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ SUCH DAMAGE.
diff --git a/debian/doc-base.hamradio-maintguide b/debian/doc-base.hamradio-maintguide
new file mode 100644
index 0000000..e6b5659
--- /dev/null
+++ b/debian/doc-base.hamradio-maintguide
@@ -0,0 +1,14 @@
+Document: hamradio-maintguide
+Title: Debian Hamradio Maintainers Guide
+Author: Iain R. Learmonth <irl at debian.org>
+Abstract:
+ The Debian Hamradio Maintainers Guide is a document that outlines team policy
+ and best current practice for the Deian Hamradio Maintainers packaging team.
+Section: Debian
+
+Format: HTML
+Index: /usr/share/doc/hamradio-maintguide/html/index.html
+Files: /usr/share/doc/hamradio-maintguide/html/*.html
+
+Format: PDF
+Files: /usr/share/doc/hamradio-maintguide/DebianHamradio.pdf.gz
diff --git a/debian/hamradio-maintguide.docs b/debian/hamradio-maintguide.docs
new file mode 100644
index 0000000..3c78417
--- /dev/null
+++ b/debian/hamradio-maintguide.docs
@@ -0,0 +1,2 @@
+_build/html
+_build/latex/DebianHamradio.pdf
diff --git a/debian/links b/debian/links
new file mode 100644
index 0000000..6ea8b91
--- /dev/null
+++ b/debian/links
@@ -0,0 +1,2 @@
+usr/share/javascript/jquery/jquery.js usr/share/doc/hamradio-maintguide/html/_static/jquery.js
+usr/share/javascript/underscore/underscore.js usr/share/doc/hamradio-maintguide/html/_static/underscore.js
diff --git a/debian/rules b/debian/rules
new file mode 100755
index 0000000..5f93f1d
--- /dev/null
+++ b/debian/rules
@@ -0,0 +1,10 @@
+#!/usr/bin/make -f
+
+%:
+ dh $@
+
+override_dh_auto_build:
+ make html
+ -rm -f _build/html/_static/jquery.js
+ -rm -f _build/html/_static/underscore.js
+ make latexpdf
diff --git a/debian/source/format b/debian/source/format
new file mode 100644
index 0000000..89ae9db
--- /dev/null
+++ b/debian/source/format
@@ -0,0 +1 @@
+3.0 (native)
diff --git a/index.rst b/index.rst
new file mode 100644
index 0000000..ae2f7dd
--- /dev/null
+++ b/index.rst
@@ -0,0 +1,50 @@
+Debian Hamradio Maintainer's Guide
+==================================
+
+Contents:
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ intro
+ packaging
+ vcs
+ qa
+
+Changelog
+---------
+
+Version 0.1
+^^^^^^^^^^^
+
+ * Initial version by Iain R. Learmonth <irl at debian.org>.
+
+Copyright
+---------
+
+Copyright 2015 (C) Iain R. Learmonth <irl at debian.org>.
+::
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGE.
+
diff --git a/intro.rst b/intro.rst
new file mode 100644
index 0000000..ac1e435
--- /dev/null
+++ b/intro.rst
@@ -0,0 +1,49 @@
+Introduction
+============
+
+The Debian Hamradio Maintainers team collaborates on maintenance of
+amateur-radio related packages for Debian. Team members may also maintain
+radio-related packages independently using the team's infrastructure; there is
+no obligation to share all radio-related package development.
+
+Anyone is welcome to join; please contact the mailing list. New team members
+may help with the existing packages or create new packages as they wish. You do
+not need to be a Debian Maintainer or Debian Developer in order to contribute
+to packages. See below for more information on getting involved.
+
+Joining the team as a packager
+------------------------------
+
+To join the team you should join our mailing list at a bare minimum. In order
+to use our Git repositories, you will need an Alioth account and this is very
+much encouraged. If possible, you are also encouraged to join our IRC channel.
+
+To join the mailing list, visit `the subscription page
+<https://lists.debian.org/debian-hams/>`_ and enter your email address to
+subscribe. You will have to reply to an email in order to confirm your
+subscription.
+
+To sign up for an Alioth account, visit `the Alioth homepage
+<https://alioth.debian.org/>`_ and register. You can then visit the `project
+page for the Hamradio Maintainers team
+<https://alioth.debian.org/projects/pkg-hamradio/>`_ and request to be added to
+the team.
+
+Our IRC channel is `#debian-hams <irc://irc.debian.org/#debian-hams>`_ on
+irc.debian.org.
+
+The following should be considered essential reading for anyone wishing to
+participate in packaging within the team:
+
+* `Debian Policy <http://www.debian.org/doc/debian-policy/>`_
+* `Developers Reference <http://www.debian.org/doc/developers-reference/>`_
+* `New Maintainers Guide <http://www.debian.org/doc/maint-guide/>`_
+* Debian Hamradio Maintainers Guide (this document)
+
+Assisting the team with translations
+------------------------------------
+
+If you speak a language other than English, you can contribute right away with
+translations of package descriptions at the `Debian Description Translation
+Project <https://www.debian.org/international/l10n/ddtp>`_.
+
diff --git a/packaging.rst b/packaging.rst
new file mode 100644
index 0000000..2fb0e9b
--- /dev/null
+++ b/packaging.rst
@@ -0,0 +1,166 @@
+Packaging
+=========
+
+Newcomer guidelines
+-------------------
+
+Newcomers may try to start off with a ``DEBIAN/`` directory and move files
+around until they have a working binary ``.deb``. This sort of package will
+never enter the official Debian archives however. The only way to get your
+package into the Debian archives is through a proper source package that
+complies with `Debian Policy <https://www.debian.org/doc/debian-policy/>`_. See
+the `Debian New Maintainers Guide
+<http://www.debian.org/doc/manuals/maint-guide/>`_ for help on getting started
+with packaging. You may also find our `package template
+<http://anonscm.debian.org/viewvc/pkg-hamradio/trunk/package_template/>`_
+useful.
+
+Announcing intention to package
+-------------------------------
+
+If the package you would like to work on is new to Debian, you should announce
+your intention to create the package. You do this by filing a WNPP bug report.
+Please add an X-Debbugs-CC header pointing to the Debian Hamradio Maintainers
+mailing list when you submit the bug.
+
+Team Policy
+-----------
+
+It will be expected that you have read the `Debian Policy`_, `Developers Reference
+<http://www.debian.org/doc/developers-reference/>`_ and the `New Maintainers
+Guide <http://www.debian.org/doc/maint-guide/>`_.
+
+In order to harmonise the packages within the Debian Hamradio Maintainers team,
+please adhere to the following additional team policy:
+
+``debian/control``
+^^^^^^^^^^^^^^^^^^
+
+The following considerations should be made when creating or modifying a
+package's control file.
+
++-------------------+--------------------------------------------------------------------------------------+
+| Section | Should be ``hamradio`` for the source package in most cases. In |
+| | some cases ``science`` will be more appropriate. |
++-------------------+--------------------------------------------------------------------------------------+
+| Priority | Should be ``optional`` unless forbidden by the Debian Policy |
+| | (see `§2.5 |
+| | <http://www.debian.org/doc/debian-policy/ch-archive.html#s-priorities>`_). |
+| | Packages of priority ``extra`` are excluded from some QA tests. |
++-------------------+--------------------------------------------------------------------------------------+
+| Maintainer | Maintainer should be ``Debian Hamradio Maintainers <debian-hams at lists.debian.org>``. |
+| | Please subscribe to this list |
+| | if you list yourself in the Uploaders: field of one of |
+| | the team's packages. |
++-------------------+--------------------------------------------------------------------------------------+
+| Uploaders | Please add yourself as an uploader when you have a significant interest in a package.|
+| | Being Uploader means that you are expected to be responsive to bug reports and act |
+| | as a primary contact for the package. For more occasional works, you can do a team |
+| | upload. There must be at least one named person in the Uploaders field for each team |
+| | package. |
++-------------------+--------------------------------------------------------------------------------------+
+| Standards-Version | Please always use the latest unless there are concerns for backporting. If no |
+| | changes are needed, please indicate this fact in the changelog, and increment |
+| | the value of the field. |
++-------------------+--------------------------------------------------------------------------------------+
+| Homepage | Should be documented whenever possible. |
++-------------------+--------------------------------------------------------------------------------------+
+| Vcs-* | Please use the following template when using the team's Git repositories on Alioth: |
+| | :: |
+| | |
+| | Vcs-Browser: http://anonscm.debian.org/cgit/pkg-hamradio/<pkg>.git |
+| | Vcs-Git: http://anonscm.debian.org/git/pkg-hamradio/<pkg>.git |
++-------------------+--------------------------------------------------------------------------------------+
+
+It is a good idea to check the syntax of the control file with *Config::Model*.
+This tool is also capable of reformatting the control file to a unified format
+(although the reformatting currently appears to only work if there are errors
+in the file to be fixed).
+::
+
+ sudo apt-get install cme libconfig-model-dpkg-perl libconfig-model-itself-perl
+ cme check dpkg-control # checks the control file syntax
+ cme fix dpkg-control # fixes errors if possible
+
+``debian/copyright``
+^^^^^^^^^^^^^^^^^^^^
+
+We use the machine-readable format for the debian/copyright file. The Source
+field does not need to contain the full URL to the particular version that is
+being packaged, since this can be determined by the uscan program with the
+debian/watch file. Please list yourself in the ``Files: debian/*``
+section if you think that your contributions are not trivial and therefore
+subjected to copyright. Please chose a license that is compatible with the
+program you package. You can also use “same as if it were in the public domain”
+or “same as the packaged program itself”.
+
+To create some reasonable skeleton for a debian/copyright file you can try the
+following:
+::
+
+ sudo apt-get install devscripts cdbs
+ licensecheck --copyright -r `find -type f` | /usr/lib/cdbs/licensecheck2dep5 > debian/copyright
+
+To verify the correct syntax of the debian/copyright file you can use
+*Config::Model* again:
+::
+
+ cme check dpkg-copyright
+
+``debian/changelog``
+^^^^^^^^^^^^^^^^^^^^
+
+Packages hosted in our Git repositories on Alioth that have been modified but
+not uploaded must use ``UNRELEASED`` as a distribution name. QA tools will use
+this to identify packages that are being worked on but for which uploads are
+not yet ready.
+
+``debian/README.source``
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+This file is recommended by the Policy (`§4.14
+<http://www.debian.org/doc/debian-policy/ch-source.html#s-readmesource>`_) from
+version 3.8.0 for documenting source package handling. Please follow the
+recommendation.
+
+``debian/README.test``
+^^^^^^^^^^^^^^^^^^^^^^
+
+This file was `recommended by the Security team
+<https://lists.debian.org/debian-devel-announce/2011/01/msg00006.html>`_ for
+describing to others than the regular maintainer how the package's
+functionality can properly be tested. If it is not obvious how to test the
+functionality of your package, please consider including this file.
+
+``debian/source/format``
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+This file sould contain “3.0 (quilt)” in order to use this source format. Other
+formats should be avoided unless they bring a specific advantage.
+
+Debhelper
+^^^^^^^^^
+
+Debhelper uses compatibility levels to control the behaviour of its commands.
+We currently recommend to use the level 9 which is available in both stable
+(jessie) and oldstable (wheezy) and has been backported to old-old-stable
+(squeeze) However, there is no urgent need to touch packages only because it
+has an older Debhelper version.
+
+It is strongly recommended to use the short dh notation in debian/rules files
+which makes code factorisation very simple and easy to understand the packaging
+for other members of the team. Even complex packaging becomes quite transparent
+this way.
+
+Team Uploads
+^^^^^^^^^^^^
+
+If you have contacted the uploaders listed for a package and they are
+unresponsive, or if you have been asked by the uploaders to perform a team
+upload, you may perform an upload without adding yourself to the uploaders
+field. Team uploads are distinguished from NMUs by adding "* Team upload" as
+the first changelog entry, and this is supported by debchange (--team).
+
+For more information about team uploads, you can see the page about `team
+uploads <https://wiki.debian.org/TeamUpload>` on the Wiki.
+
diff --git a/qa.rst b/qa.rst
new file mode 100644
index 0000000..ad3b5ca
--- /dev/null
+++ b/qa.rst
@@ -0,0 +1,47 @@
+QA Tools
+========
+
+A number of QA tools are available to the team to help track our packages. You
+can also use most of these tools to track the packages that you are an uploader
+on.
+
+Debian Developer's Package Overview
+-----------------------------------
+
+Debian Developer's Package Overview (DDPO) is a web application offering a
+customizable overview of all packages of a given maintainer.
+
+* Link: `DDPO for the Debian Hamradio Maintainers
+ <http://qa.debian.org/developer.php?login=debian-hams%40lists.debian.org&comaint=yes>`_
+
+Debian Maintainer Dashboard
+---------------------------
+
+The maintainer dashboard exposes information about teams or maintainers'
+packages. It intends to help answering the question "I have a few hours for
+Debian, what should I do now?"
+
+* Link: `DMD for the Debian Hamradio Maintainers
+ <https://udd.debian.org/dmd/?email1=debian-hams%40lists.debian.org&email2=&email3=&packages=&ignpackages=&format=html#todo>`_
+
+Package Entropy Tracker
+-----------------------
+
+PET is a collection of scripts that gather information about the teams
+packages. It allows you to see in a bird's eye view the health of hundreds of
+packages, instantly realizing where work is needed. It will also show where
+work is in progress in the git repositories.
+
+* Link: `PET for the Debian Hamradio Maintainers
+ <http://pet.debian.net/pkg-hamradio/pet.cgi>`_
+
+Lintian
+-------
+
+Lintian dissects Debian packages and tries to find bugs and policy violations.
+It contains automated checks for many aspects of Debian policy as well as some
+checks for common errors.
+
+* Link: `Lintian reports for the Debian Hamradio Maintainers
+ <https://lintian.debian.org/maintainer/debian-hams@lists.debian.org.html>`_
+
diff --git a/vcs.rst b/vcs.rst
new file mode 100644
index 0000000..287848e
--- /dev/null
+++ b/vcs.rst
@@ -0,0 +1,254 @@
+Version Control System
+======================
+
+The Debian Hamradio Maintainers team has a project on `Alioth
+<http://alioth.debian.org/>`_. You are encouraged to use this for managing git
+repositories for the source of your team packages. If you do not currently have
+an account on Alioth or have not requested to be added to the project, you will
+need to do that before you can use this facility. To request to be added to the
+project, send an email to the `mailing list
+<https://lists.debian.org/debian-hams/>`_. In order to be able to push to the
+repositories on Alioth, you will need to `add an SSH key
+<https://alioth.debian.org/account/editsshkeys.php>`_ to your Alioth account.
+
+Anonymous access to git repositories
+------------------------------------
+
+Anonymous access to git repositories is possible at the following URLs:
+
+* http://anonscm.debian.org/git/pkg-hamradio/<pkg-name>.git (Preferred for the
+ Vcs-Git field)
+* git://anonscm.debian.org/pkg-hamradio/<pkg-name>.git
+
+Anonymous access to a web VCS browser is also available at the following URL:
+
+* http://anonscm.debian.org/cgit/pkg-hamradio/<pkg-name>.git
+
+You can also view an `index of all team git repositories
+<http://anonscm.debian.org/cgit/pkg-hamradio/>`_.
+
+Repository layout
+-----------------
+
+The layout of the Git repository is important as we have QA tools that scan our
+Git repositories for information. The recommended layout for repositories is
+described by `DEP-14 <http://dep.debian.net/deps/dep14/>`_, which is
+implemented by the ``git-buildpackage`` tool. Examples of this tool in use are
+given below.
+
+Importing an existing source package
+------------------------------------
+
+You will need ``git-buildpackage`` installed on your local machine before
+following these steps.
+
+If your package is not currently tracked with git, you can import the sources
+from a source package.
+
+Begin by logging into Alioth and creating the new repository:
+::
+
+ cd /git/pkg-hamradio/
+ ./setup-repository <pkg-name> "Packaging for <pkg-name> in Debian"
+
+If you have the source package locally, you can skip this next step. If not,
+you will need to download the source package from the Debian archives:
+::
+
+ cd /tmp
+ apt-get source <pkg-name>
+
+Then you need to create a local git repository on your machine and import the
+source package:
+::
+
+ mkdir <pkg-name>
+ cd <pkg-name>
+ git init
+ gbp import-dsc --pristine-tar /tmp/<pkg-name>*.dsc
+
+Finally, in your local git repository, add the remote and push all branches and
+tags:
+::
+
+ git remote add origin git+ssh://alioth.debian.org/git/pkg-hamradio/<pkg-name>.git
+ git push origin --all
+ git push origin --tags
+
+Please remember to update your ``Vcs-Git`` and ``Vcs-Browser`` fields in
+``debian/control`` to match the URLs shown above for anonymous access.
+
+Importing an existing git repository
+------------------------------------
+
+You will need ``git-buildpackage`` installed on your local machine before
+following these steps.
+
+If you've previously had a git repository elsewhere for your package, you can
+import it quite easily.
+
+Begin by logging into Alioth and creating the new repository:
+::
+
+ cd /git/pkg-hamradio/
+ ./setup-repository <pkg-name> "Packaging for <pkg-name> in Debian"
+
+Then in your local git repository, add the remote and push all branches and
+tags:
+::
+
+ git remote remove origin
+ git remote add origin git+ssh://alioth.debian.org/git/pkg-hamradio/<pkg-name>.git
+ git push origin --all
+ git push origin --tags
+
+This repository can now be cloned using git-buildpackage or you can continue to
+work in your local repository pushing changes to the new origin.
+
+Please remember to update your ``Vcs-Git`` and ``Vcs-Browser`` fields in
+``debian/control`` to match the URLs shown above for anonymous access.
+
+Even if your existing repository is on Alioth, do **NOT** just copy the
+repository into ``/git/pkg-hamradio/``. The ``setup-repository`` script
+adds commit hooks to the repository to aid in tracking commits.
+
+Creating a new git repository for a new package
+-----------------------------------------------
+
+You will need ``git-buildpackage`` installed on your local machine before
+following these steps.
+
+Begin by logging into Alioth and creating the new repository:
+::
+
+ cd /git/pkg-hamradio/
+ ./setup-repository <pkg-name> "Packaging for <pkg-name> in Debian"
+
+On your machine, download the upstream source tarball and keep it somewhere
+safe. You will need a tarball to import, so if upstream distributes source as a
+zip or other type of archive, you will need to repack it as a tarball.
+
+Create a local git repository on your machine and import the tarball like so:
+::
+
+ mkdir <pkg-name>
+ cd <pkg-name>
+ git init
+ gbp import-orig --pristine-tar /path/to/upstream/source.tar.gz
+
+You'll now find that the upstream source has been imported into your git
+repository.
+
+You may optionally use the Debian Hamradio Maintainers template ``debian/``
+directory:
+::
+
+ svn export svn://anonscm.debian.org/svn/pkg-hamradio/trunk/package_template debian
+
+When you are ready to push your changes to Alioth, add the remote and push all
+branches and tags:
+::
+
+ git remote add origin git+ssh://alioth.debian.org/git/pkg-hamradio/<pkg-name>.git
+ git push --all
+ git push --tags
+
+Testing package builds with git-buildpackage
+--------------------------------------------
+
+While building your package with git-pbuilder as described below will help you
+to test building your package on a clean system and check your build
+dependencies, it can take a long time to install the build dependencies every
+time. You can build your package in the directory on your development system
+while debugging build problems.
+::
+
+ gbp buildpackage -us -uc
+
+.. note:: The ``-us -uc`` options will be passed to ``dpkg-buildpackage`` and
+ disable the automatic signing of the package. There is no need to
+ sign the built packages when debugging.
+
+The .dsc, .changes, .orig.tar.gz, .debian.tar.xz and .deb files will be placed
+in the parent directory to your git repository.
+
+Using git-buildpackage and git-pbuilder for building packages
+-------------------------------------------------------------
+
+``git-pbuilder`` builds your package in a chroot which ensures that your
+package has the correct package dependencies and does not depend on any files
+outside of the repository. It is included in the ``git-buildpackage`` package.
+
+The first time you use git-pbuilder, you'll need to create a local unstable
+chroot for the builds to be performed in. You will also need to make sure
+cowbuilder is available on your system.
+::
+
+ sudo apt-get install cowbuilder
+ sudo git-pbuilder create
+
+In order to build your package from the git repository, run:
+::
+
+ cd /path/to/repository
+ gbp buildpackage --git-pbuilder
+
+Final build and upload
+----------------------
+
+If your package is ready for upload, you can update the changelog, perform a
+final build with the updated changelog, sign your package using debsign and
+then upload:
+::
+
+ dch -r # this will set the distribution to unstable
+ gbp buildpackage --git-pbuilder --git-tag
+ cd ../
+ debsign <pkg>*.changes
+ dput <target> <pkg>*.changes
+
+.. note:: You may choose to do the final build without ``git-pbuilder``, in
+ which case you can omit the ``--git-pbuilder`` argument from the
+ call to ``gbp buildpackage``. The .dsc and .changes files will also
+ be signed during the build so you do not have to use ``debsign`` if
+ you are not using ``git-pbuilder`` for the final build.
+
+If you're not a Debian Maintainer or Debian Developer, you will not be able to
+upload directly into the Debian archives. See the "Publishing your packages"
+section of the `mentors.debian.org introduction
+<http://mentors.debian.net/intro-maintainers>`_ to learn how to upload your
+package there and then send a mail to the mailing list requesting sponsorship
+for your package.
+
+Backports and updates to stable distributions
+---------------------------------------------
+
+Backports and updates to stable distributions should be managed in a seperate
+branch in the Git repositories. Backports should be managed in the branch with
+the name of the stable distribution, e.g. the branch containing backports for
+the current stable distribution should be named "jessie". Proposed updates for
+the stable distributions should be managed in the branch with the name of the
+stable distribution with "-pu" appended, e.g. the branch containing proposed
+updates for the current stable distribution should be named "jessie-pu".
+
+In order to use git-buildpackage to build the alternative branch, use the
+--git-debian-branch argument:
+::
+ gbp buildpackage --git-pbuilder --git-debian-branch=jessie
+
+Tracking commit notifications
+-----------------------------
+
+Commit notifications are displayed in the `#debian-hams
+<irc://irc.debian.org/#debian-hams>`_ IRC channel on irc.debian.org and can
+also be found on the `pkg-hamradio-commits at lists.alioth.debian.org
+<https://lists.alioth.debian.org/mailman/listinfo/pkg-hamradio-commits>`_
+mailing list (`archives
+<http://lists.alioth.debian.org/pipermail/pkg-hamradio-commits/>`_).
+
+Futher Reading
+--------------
+
+For more information on using Git for packaging, see `the Git packages pages on
+the wiki <http://wiki.debian.org/GitPackaging>`_.
+
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-hamradio/hamradio-maintguide.git
More information about the pkg-hamradio-commits
mailing list