.gitignore: pycharm remote execution update

[mirror_ifupdown2.git] / docs / source / intro.rst

diff --git a/docs/source/intro.rst b/docs/source/intro.rst
index a08dc86ff8455e2b4b715906e4ef71765d62110c..7293e3f9f29b049bfe137de69a7f2e87faae9479 100644 (file)
--- a/docs/source/intro.rst
+++ b/docs/source/intro.rst
@@ -1,55 +1,31 @@
-Introduction
-============
-ifupdown2 is a replacement for the debian network interface
-management package ifupdown. It is ifupdown re-written in python. It
-maintains the original ifupdown pluggable architecture and extends it further.
-
-It comes as two packages:
-    * python-ifupdown2
-    * python-ifupdown2-addons
-
-(Packaging may change in the future)
-
 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 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/.
-
-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.
-
-ifupdown2 module calls all modules for every interface declared in the
-/etc/network/interfaces file.
-
-
-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
+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.
+
+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.
 
 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
+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 details on how to add a module, see the api reference and development
-documentation.
+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.
+