From 0edaee373fee99a784a3daf5ac86f2258c1691ab Mon Sep 17 00:00:00 2001 From: Roopa Prabhu Date: Tue, 10 Mar 2015 14:18:30 -0700 Subject: [PATCH] merge docs.addons content into docs directory Ticket: Reviewed By: Testing Done: --- docs.addons/Makefile | 153 ----------- docs.addons/source/conf.py | 247 ------------------ docs.addons/source/developmentcorner.rst | 58 ---- docs.addons/source/gettingstarted.rst | 29 -- docs.addons/source/index.rst | 25 -- docs.addons/source/intro.rst | 21 -- {docs.addons => docs}/source/addonsapiref.rst | 0 .../source/addonshelperapiref.rst | 0 docs/source/conf.py | 4 + docs/source/developmentcorner.rst | 63 ++++- docs/source/gettingstarted.rst | 10 +- docs/source/intro.rst | 33 ++- 12 files changed, 88 insertions(+), 555 deletions(-) delete mode 100644 docs.addons/Makefile delete mode 100644 docs.addons/source/conf.py delete mode 100644 docs.addons/source/developmentcorner.rst delete mode 100644 docs.addons/source/gettingstarted.rst delete mode 100644 docs.addons/source/index.rst delete mode 100644 docs.addons/source/intro.rst rename {docs.addons => docs}/source/addonsapiref.rst (100%) rename {docs.addons => docs}/source/addonshelperapiref.rst (100%) diff --git a/docs.addons/Makefile b/docs.addons/Makefile deleted file mode 100644 index 9b5efd7..0000000 --- a/docs.addons/Makefile +++ /dev/null @@ -1,153 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.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 ' where 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 " 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 " 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/ifupdown2.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ifupdown2.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/ifupdown2" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ifupdown2" - @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." - -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." diff --git a/docs.addons/source/conf.py b/docs.addons/source/conf.py deleted file mode 100644 index e9ddb8d..0000000 --- a/docs.addons/source/conf.py +++ /dev/null @@ -1,247 +0,0 @@ -# -*- coding: utf-8 -*- -# -# ifupdown2-addons documentation build configuration file, created by -# sphinx-quickstart on Mon Jul 21 11:17:17 2014. -# -# 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, 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('.')) - -sys.path.insert(0, os.path.abspath('../../addons')) -sys.path.append(os.path.abspath('../../')) -sys.path.append(os.path.abspath('../../ifupdownaddons')) -sys.path.append(os.path.abspath('../../../ifupdown2')) - -# -- 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.autodoc'] - -# 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'ifupdown2-addons' -copyright = u'2014, Roopa Prabhu' - -# 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 = [] - -# 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 = [] - - -# -- 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 -# " v 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'] - -# 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 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 = 'ifupdown2-addonsdoc' - - -# -- 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]). -latex_documents = [ - ('index', 'ifupdown2-addons.tex', u'ifupdown2-addons Documentation', - u'Roopa Prabhu', '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', 'ifupdown2-addons', u'ifupdown2-addons Documentation', - [u'Roopa Prabhu'], 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', 'ifupdown2-addons', u'ifupdown2-addons Documentation', - u'Roopa Prabhu', 'ifupdown2-addons', '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' diff --git a/docs.addons/source/developmentcorner.rst b/docs.addons/source/developmentcorner.rst deleted file mode 100644 index be5c563..0000000 --- a/docs.addons/source/developmentcorner.rst +++ /dev/null @@ -1,58 +0,0 @@ -Development Corner -================== - -Writing a ifupdown2 addon module --------------------------------- -ifupdown2 addon modules are part of the python-ifupdown2-addons package. -They are installed under /usr/share/ifupdownaddons directory on the target -system. - -The center of the universe for an addon module is the 'class iface' object -exported by the python-ifupdown2 package. - -The iface object is modeled after an iface entry in the user provided network -configuration file (eg. /etc/network/interfaces). For more details see -the api reference for the iface class. - -ifupdown2 dynamically loads a python addon module. It expects the addon module -to implement a few methods. - -* all addon modules must inherit from moduleBase class -* the module must implement a class by the same name -* the network interface object (class iface) and the operation to be performed - is passed to the modules. Operation can be any of 'pre-up', 'up', 'post-up', - 'pre-down', 'down', 'post-down', 'query-check', 'query-running'. - The module can choose to support a subset or all operations. - In cases when the operation is query-check, the module must compare between - the given and running state and return the checked state of the object in - queryobjcur passed as argument to the run menthod. -* the python addon class must provide a few methods: - * run() : method to configure the interface. - * get_ops() : must return a list of operations it supports. - eg: 'pre-up', 'post-down' - * get_dependent_ifacenames() : must return a list of interfaces the - supported interface is dependent on. This is used to build the - dependency list for sorting and executing interfaces in dependency order. - * if the module supports -r option to ifquery, ie ability to construct the - ifaceobj from running state, it can optionally implement the - get_dependent_ifacenames_running() method, to return the list of - dependent interfaces derived from running state of the interface. - This is different from get_dependent_ifacenames() where the dependent - interfaces are derived from the interfaces config file (provided by the - user). - * provide a dictionary of all supported attributes in the _modinfo - attribute. This is useful for syntax help and man page generation. - -python-ifupdown2-addons package also installs ifupdownaddons python package -that contains helper modules for all addon modules. Its optional for the addon -module to use this package. - -see example address handling module /usr/share/ifupdownaddons/address.py - -API reference -------------- -.. toctree:: - :maxdepth: 2 - - addonsapiref.rst - addonshelperapiref.rst diff --git a/docs.addons/source/gettingstarted.rst b/docs.addons/source/gettingstarted.rst deleted file mode 100644 index e4345ca..0000000 --- a/docs.addons/source/gettingstarted.rst +++ /dev/null @@ -1,29 +0,0 @@ -Getting Started -=============== - -Prerequisites -------------- -* python-ifupdown2-addons is currently only tested on debian wheezy -* python-ifupdown2-addons needs python version 2.6 or greater -* build depends on: python-stdeb (for deb builds), python-docutils (for rst2man) -* depends on python-gvgen package for printing interface graphs (this will be made optional in the future) -* optional dependency for template engine: python-mako -* python-ifupdown2-addons has an install dependency on python-ifupdown2 - -Building --------- -$git clone ifupdown2 - -$cd ifupdown2/ifupdown2-addons - -$./build.sh - -Installing ----------- -install generated python-ifupdown2-addons-.deb using dpkg - -$dpkg -i .deb - - - - diff --git a/docs.addons/source/index.rst b/docs.addons/source/index.rst deleted file mode 100644 index 27b6fd6..0000000 --- a/docs.addons/source/index.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. ifupdown2 documentation master file, created by - sphinx-quickstart on Sun Jul 6 23:49:20 2014. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to ifupdown2-addons documentation! -========================================== - -Contents: -========= - -.. toctree:: - :maxdepth: 2 - - intro.rst - gettingstarted.rst - developmentcorner.rst - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/docs.addons/source/intro.rst b/docs.addons/source/intro.rst deleted file mode 100644 index 35f187e..0000000 --- a/docs.addons/source/intro.rst +++ /dev/null @@ -1,21 +0,0 @@ -python-ifupdown2-addons ------------------------ - -The python-ifupdown2-addons package contains ifupdown2 addon modules. - -addon modules are responsible for applying interface configuration. -The modules are installed under /usr/share/ifupdownmodules. - -Each module can declare its own set of supported attributes. Each module -is passed the iface object (which is a representation of /etc/network/interfaces -iface entry). Each module is also passed the operation to be performed. - -Example modules are /usr/share/ifupdownmodules/address.py, -/usr/share/ifupdownmodules/bridge.py etc - -The order in which these modules are invoked is listed in -/var/lib/ifupdownaddons/addons.conf. There is a ifaddon utility in the works -to better manage the module ordering. - -For details on how to add a module, see the api reference and development -documentation. diff --git a/docs.addons/source/addonsapiref.rst b/docs/source/addonsapiref.rst similarity index 100% rename from docs.addons/source/addonsapiref.rst rename to docs/source/addonsapiref.rst diff --git a/docs.addons/source/addonshelperapiref.rst b/docs/source/addonshelperapiref.rst similarity index 100% rename from docs.addons/source/addonshelperapiref.rst rename to docs/source/addonshelperapiref.rst diff --git a/docs/source/conf.py b/docs/source/conf.py index 19cbdb2..01bc5cc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -17,6 +17,10 @@ import sys, os # 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('../../ifupdown')) +sys.path.append(os.path.abspath('../../addons')) +sys.path.append(os.path.abspath('../../')) +sys.path.append(os.path.abspath('../../ifupdownaddons')) +sys.path.append(os.path.abspath('../../../ifupdown2')) # -- General configuration ----------------------------------------------------- diff --git a/docs/source/developmentcorner.rst b/docs/source/developmentcorner.rst index c4ea51b..960d688 100644 --- a/docs/source/developmentcorner.rst +++ b/docs/source/developmentcorner.rst @@ -1,7 +1,7 @@ Development Corner ================== -getting started +Getting started --------------- Unlike original ifupdown, all interface configuration is moved to external python modules. That includes inet, inet6 and dhcp configurations. @@ -10,12 +10,63 @@ python modules. That includes inet, inet6 and dhcp configurations. infrastructure package, pls look at the apiref, documentation and code for python-ifupdown2 -* if you are looking at developing a new module, pls look at writing a addon - module in the python-ifupdown2-addons documentation -Apiref ------- +Writing a ifupdown2 addon module +-------------------------------- +Addon modules are a nice way to add additional functionality to ifupdown2. +Typically a new addon module will include support for a new network interface +configuration which is not already supported by existing ifupdown2 addon +modules. + +ifupdown2 addon modules are written in python. python-ifupdown2 package +comes with default addon modules. All addon modules are installed under +/usr/share/ifupdownaddons directory. + +The center of the universe for an addon module is the 'class iface' object +exported by the python-ifupdown2 package. + +The iface object is modeled after an iface entry in the user provided network +configuration file (eg. /etc/network/interfaces). For more details see +the api reference for the iface class. + +ifupdown2 dynamically loads a python addon module. It expects the addon module +to implement a few methods. + +* all addon modules must inherit from moduleBase class +* the module must implement a class by the same name +* the network interface object (class iface) and the operation to be performed + is passed to the modules. Operation can be any of 'pre-up', 'up', 'post-up', + 'pre-down', 'down', 'post-down', 'query-check', 'query-running'. + The module can choose to support a subset or all operations. + In cases when the operation is query-check, the module must compare between + the given and running state and return the checked state of the object in + queryobjcur passed as argument to the run menthod. +* the python addon class must provide a few methods: + * run() : method to configure the interface. + * get_ops() : must return a list of operations it supports. + eg: 'pre-up', 'post-down' + * get_dependent_ifacenames() : must return a list of interfaces the + supported interface is dependent on. This is used to build the + dependency list for sorting and executing interfaces in dependency order. + * if the module supports -r option to ifquery, ie ability to construct the + ifaceobj from running state, it can optionally implement the + get_dependent_ifacenames_running() method, to return the list of + dependent interfaces derived from running state of the interface. + This is different from get_dependent_ifacenames() where the dependent + interfaces are derived from the interfaces config file (provided by the + user). + * provide a dictionary of all supported attributes in the _modinfo + attribute. This is useful for syntax help and man page generation. + +python-ifupdown2 package also installs ifupdownaddons python package +that contains helper modules for all addon modules. + +see example address handling module /usr/share/ifupdownaddons/address.py + +API reference +------------- .. toctree:: :maxdepth: 2 - apiref.rst + addonsapiref.rst + addonshelperapiref.rst diff --git a/docs/source/gettingstarted.rst b/docs/source/gettingstarted.rst index 16db725..4d7f6cb 100644 --- a/docs/source/gettingstarted.rst +++ b/docs/source/gettingstarted.rst @@ -5,10 +5,10 @@ Prerequisites ------------- * python-ifupdown2 is currently only tested on debian wheezy * python-ifupdown2 needs python version 2.6 or greater -* build depends on: python-stdeb (for deb builds), python-docutils (for rst2man) -* depends on python-gvgen package for printing interface graphs (this will be made optional in the future) -* optional dependency for template engine: python-mako -* python-ifupdown2 needs python-ifupdown2-addons to function correctly +* Depends on: python-stdeb (for deb builds), python-docutils + (for rst2man), python-argcomplete, 'python-ipaddr' +* Depends on python-gvgen package for printing interface graphs (this will be made optional in the future) +* Optional dependency for template engine: python-mako Building @@ -23,5 +23,5 @@ Installing ---------- install generated python-ifupdown2-.deb -$dpkg -i .deb +$dpkg -i .deb diff --git a/docs/source/intro.rst b/docs/source/intro.rst index d81ab95..7293e3f 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -4,17 +4,28 @@ python-ifupdown2 The python-ifupdown2 package provides the infrastructure for parsing /etc/network/interfaces file, loading, scheduling, template parsing, state management and interface dependency generation of interfaces. +It dynamically loads python addon modules from /usr/share/ifupdownmodules. +To remain compatible with other packages that depend on ifupdown, it also +executes scripts under /etc/network/. To make the transition smoother, a +python module under /usr/share/ifupdownmodules will override a script by +the same name under /etc/network/. ifupdown2 publishes an interface object which +is passed to all loadble python addon modules. All lodable modules are +called for every interface declared in the /etc/network/interfaces file. -It dynamically loads python modules from /usr/share/ifupdownmodules (provided -by the python-ifupdown2-addons package). To remain compatible with other -packages that depend on ifupdown, it also executes scripts under /etc/network/. -To make the transition smoother, a python module under -/usr/share/ifupdownmodules will override a script by the same name under -/etc/network/. +Addon modules are responsible for applying interface configuration. +python-ifupdown2 ships with a set of default addon modules. Each module can +declare its own set of supported attributes. Each module is passed the iface +object (which is a representation of /etc/network/interfaces +iface entry). Each module is also passed the operation to be performed. -It publishes an interface object which is passed to all loadble python -modules. For more details on adding a addon module, see the section on -adding python modules. +Example modules are /usr/share/ifupdownmodules/address.py, +/usr/share/ifupdownmodules/bridge.py etc + +The order in which these modules are invoked is listed in +/var/lib/ifupdownaddons/addons.conf. There is an ifaddon utility in the works +to better manage the module ordering. + +For more details on adding an addon module, see the section on adding python +modules. For details on how to write a module, see the api reference and +development documentation. -ifupdown2 module calls all modules for every interface declared in the -/etc/network/interfaces file.