Move class docstrings into classes, add module docstrings to feed catalyst-spec(5...
authorSebastian Pipping <sebastian@pipping.org>
Mon, 9 Jul 2012 15:41:44 +0000 (17:41 +0200)
committerSebastian Pipping <sebastian@pipping.org>
Mon, 9 Jul 2012 15:41:44 +0000 (17:41 +0200)
14 files changed:
modules/embedded_target.py
modules/generic_stage_target.py
modules/generic_target.py
modules/grp_target.py
modules/livecd_stage1_target.py
modules/livecd_stage2_target.py
modules/netboot2_target.py
modules/netboot_target.py
modules/snapshot_target.py
modules/stage1_target.py
modules/stage2_target.py
modules/stage3_target.py
modules/stage4_target.py
modules/tinderbox_target.py

index 2ab8cc5a243ece31226a296c1fd2d7e02b76f169..6d34a57693989ef858bca7d64a3ff130d0cbae22 100644 (file)
@@ -1,13 +1,14 @@
-
 """
-This class works like a 'stage3'.  A stage2 tarball is unpacked, but instead
-of building a stage3, it emerges a 'system' into another directory
-inside the 'stage2' system.  This way we do not have to emerge gcc/portage
-into the staged system.
+Enbedded target, similar to the stage2 target, builds upon a stage2 tarball.
 
-It sounds real complicated but basically it runs
-ROOT=/tmp/submerge emerge --blahblah foo bar
+A stage2 tarball is unpacked, but instead
+of building a stage3, it emerges @system into another directory
+inside the stage2 system.  This way, we do not have to emerge GCC/portage
+into the staged system.
+It may sound complicated but basically it runs
+ROOT=/tmp/submerge emerge --something foo bar .
 """
+# NOTE: That^^ docstring has influence catalyst-spec(5) man page generation.
 
 import os,string,imp,types,shutil
 from catalyst_support import *
@@ -15,7 +16,9 @@ from generic_stage_target import *
 from stat import *
 
 class embedded_target(generic_stage_target):
-
+       """
+       Builder class for embedded target
+       """
        def __init__(self,spec,addlargs):
                self.required_values=[]
                self.valid_values=[]
index 5947e9a1d1acfb89dca2b136b9e9f56bb7c2d56c..c4ef239c17bb489f16d827332a8e64f7f5dd25cd 100644 (file)
@@ -1,9 +1,3 @@
-
-"""
-This class does all of the chroot setup, copying of files, etc. It is
-the driver class for pretty much everything that Catalyst does.
-"""
-
 import os,string,imp,types,shutil
 from catalyst_support import *
 from generic_target import *
@@ -11,7 +5,10 @@ from stat import *
 import catalyst_lock
 
 class generic_stage_target(generic_target):
-
+       """
+       This class does all of the chroot setup, copying of files, etc. It is
+       the driver class for pretty much everything that Catalyst does.
+       """
        def __init__(self,myspec,addlargs):
                self.required_values.extend(["version_stamp","target","subarch",\
                        "rel_type","profile","snapshot","source_subpath"])
index 82a4c56b0b0875f4480b2c5a19dbc2cb108840b8..fe96bd73f8c95cccf1ed47bae1f40150fe1ecdf5 100644 (file)
@@ -1,12 +1,9 @@
-
-"""
-The toplevel class for generic_stage_target. This is about as generic as we get.
-"""
-
 from catalyst_support import *
 
 class generic_target:
-
+       """
+       The toplevel class for generic_stage_target. This is about as generic as we get.
+       """
        def __init__(self,myspec,addlargs):
                addl_arg_parse(myspec,addlargs,self.required_values,self.valid_values)
                self.settings=myspec
index b077d9c855b7f420df9dc1b0747d60b6b308f3ae..88a91c789829e4a2d03762937a7310473f113c7e 100644 (file)
@@ -1,13 +1,16 @@
-
 """
-The builder class for GRP (Gentoo Reference Platform) builds.
+Gentoo Reference Platform (GRP) target
 """
+# NOTE: That^^ docstring has influence catalyst-spec(5) man page generation.
 
 import os,types,glob
 from catalyst_support import *
 from generic_stage_target import *
 
 class grp_target(generic_stage_target):
+       """
+       The builder class for GRP (Gentoo Reference Platform) builds.
+       """
        def __init__(self,spec,addlargs):
                self.required_values=["version_stamp","target","subarch",\
                        "rel_type","profile","snapshot","source_subpath"]
index 0d5c97c8a129eefdf4fa41dfbd6b38f40c1da099..58e2e80eac6123619e4bffe5a125f3c62ace8841 100644 (file)
@@ -1,12 +1,15 @@
-
 """
-Builder class for LiveCD stage1.
+LiveCD stage1 target
 """
+# NOTE: That^^ docstring has influence catalyst-spec(5) man page generation.
 
 from catalyst_support import *
 from generic_stage_target import *
 
 class livecd_stage1_target(generic_stage_target):
+       """
+       Builder class for LiveCD stage1.
+       """
        def __init__(self,spec,addlargs):
                self.required_values=["livecd/packages"]
                self.valid_values=self.required_values[:]
index 2b126ed29295ff538016a6407dda9a1e45e00ef6..11dcc63274e2d1b03d61eb86193e001b5ca0c3e9 100644 (file)
@@ -1,13 +1,16 @@
-
 """
-Builder class for a LiveCD stage2 build.
+LiveCD stage2 target, builds upon previous LiveCD stage1 tarball
 """
+# NOTE: That^^ docstring has influence catalyst-spec(5) man page generation.
 
 import os,string,types,stat,shutil
 from catalyst_support import *
 from generic_stage_target import *
 
 class livecd_stage2_target(generic_stage_target):
+       """
+       Builder class for a LiveCD stage2 build.
+       """
        def __init__(self,spec,addlargs):
                self.required_values=["boot/kernel"]
                
index 444f873c098324e71c4b69934e0e2562bbf4465d..c4d8311ce85de8bc1435c821fc28434cbb39320d 100644 (file)
@@ -1,13 +1,16 @@
-
 """
-Builder class for a netboot build, version 2
+netboot target, version 2
 """
+# NOTE: That^^ docstring has influence catalyst-spec(5) man page generation.
 
 import os,string,types
 from catalyst_support import *
 from generic_stage_target import *
 
 class netboot2_target(generic_stage_target):
+       """
+       Builder class for a netboot build, version 2
+       """
        def __init__(self,spec,addlargs):
                self.required_values=[
                        "boot/kernel"
index 92c1b0452918b3035763049370b66ca4363a31a7..2f2435e34cad83d5337e2b6a934de530f205667c 100644 (file)
@@ -1,13 +1,16 @@
-
 """
-Builder class for a netboot build.
+netboot target, version 1
 """
+# NOTE: That^^ docstring has influence catalyst-spec(5) man page generation.
 
 import os,string,types
 from catalyst_support import *
 from generic_stage_target import *
 
 class netboot_target(generic_stage_target):
+       """
+       Builder class for a netboot build.
+       """
        def __init__(self,spec,addlargs):
                self.valid_values = [
                        "netboot/kernel/sources",
index 0609377b8c1e9a9b5e562ccd8cc2110de1247a71..a427b191826e6f4c1191095b83b58f3737bf475a 100644 (file)
@@ -1,6 +1,5 @@
-
 """
-Builder class for snapshots.
+Snapshot target
 """
 
 import os
@@ -8,6 +7,9 @@ from catalyst_support import *
 from generic_stage_target import *
 
 class snapshot_target(generic_stage_target):
+       """
+       Builder class for snapshots.
+       """
        def __init__(self,myspec,addlargs):
                self.required_values=["version_stamp","target"]
                self.valid_values=["version_stamp","target"]
index a6eb435201c6e1a77a1ccda7b9bf1f687568ec8c..32e63344b6acae61b0c4bd82af78d78db560e3d1 100644 (file)
@@ -1,12 +1,15 @@
-
 """
-Builder class for a stage1 installation tarball build.
+stage1 target
 """
+# NOTE: That^^ docstring has influence catalyst-spec(5) man page generation.
 
 from catalyst_support import *
 from generic_stage_target import *
 
 class stage1_target(generic_stage_target):
+       """
+       Builder class for a stage1 installation tarball build.
+       """
        def __init__(self,spec,addlargs):
                self.required_values=[]
                self.valid_values=["chost"]
index a5135b250c95dcc0df4033903c35116950106635..f5297212eeb426d969785885bb61f8ee5d50670a 100644 (file)
@@ -1,12 +1,15 @@
-
 """
-Builder class for a stage2 installation tarball build.
+stage2 target, builds upon previous stage1 tarball
 """
+# NOTE: That^^ docstring has influence catalyst-spec(5) man page generation.
 
 from catalyst_support import *
 from generic_stage_target import *
 
 class stage2_target(generic_stage_target):
+       """
+       Builder class for a stage2 installation tarball build.
+       """
        def __init__(self,spec,addlargs):
                self.required_values=[]
                self.valid_values=["chost"]
index 6ebdc4950ff61d7cfd5240d8f71885ea9bcba6b2..8c839dfc085241c3a5cf1d4297dfbcc2b4032129 100644 (file)
@@ -1,12 +1,15 @@
-
 """
-Builder class for a stage3 installation tarball build.
+stage3 target, builds upon previous stage2/stage3 tarball
 """
+# NOTE: That^^ docstring has influence catalyst-spec(5) man page generation.
 
 from catalyst_support import *
 from generic_stage_target import *
 
 class stage3_target(generic_stage_target):
+       """
+       Builder class for a stage3 installation tarball build.
+       """
        def __init__(self,spec,addlargs):
                self.required_values=[]
                self.valid_values=[]
index cc8e6c0287e12e98628fa030273977d70ce14b90..591f9b20960f2989f246661831fd3f7a0be02558 100644 (file)
@@ -1,12 +1,15 @@
-
 """
-Builder class for stage4.
+stage4 target, builds upon previous stage3/stage4 tarball
 """
+# NOTE: That^^ docstring has influence catalyst-spec(5) man page generation.
 
 from catalyst_support import *
 from generic_stage_target import *
 
 class stage4_target(generic_stage_target):
+       """
+       Builder class for stage4.
+       """
        def __init__(self,spec,addlargs):
                self.required_values=["stage4/packages"]
                self.valid_values=self.required_values[:]
index 42ad6eb8a656fec5a1a7fbe6720ffe3b5fa6d329..9cc1acc916e0fb8b14cf9fc611c664f1e32e0c2f 100644 (file)
@@ -1,12 +1,15 @@
-
 """
-builder class for the tinderbox target
+Tinderbox target
 """
+# NOTE: That^^ docstring has influence catalyst-spec(5) man page generation.
 
 from catalyst_support import *
 from generic_stage_target import *
 
 class tinderbox_target(generic_stage_target):
+       """
+       Builder class for the tinderbox target
+       """
        def __init__(self,spec,addlargs):
                self.required_values=["tinderbox/packages"]
                self.valid_values=self.required_values[:]