[Fai-commit] r4711 - people/michael/features/setup_harddisks_2/implementation

michael-guest at alioth.debian.org michael-guest at alioth.debian.org
Sun Nov 11 10:54:45 UTC 2007


Author: michael-guest
Date: 2007-11-11 10:54:45 +0000 (Sun, 11 Nov 2007)
New Revision: 4711

Modified:
   people/michael/features/setup_harddisks_2/implementation/shdd2
   people/michael/features/setup_harddisks_2/implementation/shdd2-init
   people/michael/features/setup_harddisks_2/implementation/shdd2-parser
Log:
moved big chunks of documentation to the wiki page


Modified: people/michael/features/setup_harddisks_2/implementation/shdd2
===================================================================
--- people/michael/features/setup_harddisks_2/implementation/shdd2	2007-11-11 10:43:58 UTC (rev 4710)
+++ people/michael/features/setup_harddisks_2/implementation/shdd2	2007-11-11 10:54:45 UTC (rev 4711)
@@ -40,29 +40,6 @@
 #
 ################################################################################
 
-################################################################################
-# TODO list
-# - parted, libparse-recdescent-perl must get installed in nfsroot (add Depends:
-#   to fai-nfsroot package)
-#
-# - closes #380629, #330915, #277045, #356862, #416633
-# - no-bug: #364763
-#
-# - auto mode (something like auto:server, auto:desktop?)
-# - man page
-#
-# - resize should imply resizing the filesystem as well (unless this is done by
-#   parted already, needs to be checked)
-# - LVMs definitely require resizing the filesystem
-# - more error messages must be caught by shdd2-exec
-# - how to detect old-style config files? migration strategies?
-# - implement disklabels other than msdos and gpt
-# - the RAID commands are surely incomplete and lack any management of
-#   unanticipated situations
-# - try to get libparted-swig-perl and use that one instead of the manual
-#   parsing
-################################################################################
-
 package FAI;
 
 # command line parameter handling

Modified: people/michael/features/setup_harddisks_2/implementation/shdd2-init
===================================================================
--- people/michael/features/setup_harddisks_2/implementation/shdd2-init	2007-11-11 10:43:58 UTC (rev 4710)
+++ people/michael/features/setup_harddisks_2/implementation/shdd2-init	2007-11-11 10:54:45 UTC (rev 4711)
@@ -26,6 +26,9 @@
 #
 # @brief Initialize all variables and acquire the set of disks of the system.
 #
+# The layout of the data structures is documented in the wiki:
+# http://faiwiki.debian.net/index.php/Setup_harddisks_2
+#
 # $Id$
 #
 # @author Christian Kern, Michael Tautschnig
@@ -72,58 +75,6 @@
 #
 # @brief The hash of all configurations specified in the disk_config file
 #
-# The structure is as follows:
-# PHY_<DEVICE>
-#   virtual (0|1)
-#   disklabel STRING
-#   bootable -1..n
-#   partitions
-#     <1..n>
-#       size
-#         extended (0|1)
-#         preserve (0|1)
-#         resize (0|1)
-#         range
-#         eff_size
-#       number 1..n
-#       maps_to_existing 1..n
-#       start_byte
-#       end_byte
-#       mountpoint
-#       mount_options
-#       filesystem
-#       fs_options
-#       label
-# VG_<NAME>
-#   devices
-#   estimated_size
-#   volumes
-#     <logical-volume-name>
-#       size
-#         preserve (0|1)
-#         resize (0|1)
-#         range
-#         eff_size
-#       mountpoint
-#       mount_options
-#       filesystem
-#       fs_options
-#       label
-# RAID
-#   volumes
-#     <0..n>
-#       mode
-#       devices
-#         /dev/<device-name>
-#           options
-#             spare (0|1)
-#             missing (0|1)
-#       mountpoint
-#       mount_options
-#       filesystem
-#       fs_options
-#       label
-#
 ################################################################################
 %FAI::configs = ();
 
@@ -131,23 +82,6 @@
 #
 # @brief The current disk configuration
 #
-# The structure is as follows:
-# <DEVICE>
-#   bios_cylinders
-#   bios_heads
-#   bios_sectors_per_track
-#   sector_size
-#   disklabel
-#   begin_byte
-#   end_byte
-#   partitions
-#     <1..n>
-#       begin_byte
-#       end_byte
-#       count_byte
-#       is_extended
-#       filesystem
-#
 ################################################################################
 %FAI::current_config = ();
 
@@ -155,14 +89,6 @@
 #
 # @brief The current LVM configuration
 #
-# The structure is as follows:
-# <VG>
-#   physical_volumes
-#   size
-#   volumes
-#     <lv-name>
-#       size
-#
 ################################################################################
 %FAI::current_lvm_config = ();
 
@@ -170,11 +96,6 @@
 #
 # @brief The current RAID configuration
 #
-# The structure is as follows:
-# <0..n>
-#   devices
-#   mode
-#
 ################################################################################
 %FAI::current_raid_config = ();
 

Modified: people/michael/features/setup_harddisks_2/implementation/shdd2-parser
===================================================================
--- people/michael/features/setup_harddisks_2/implementation/shdd2-parser	2007-11-11 10:43:58 UTC (rev 4710)
+++ people/michael/features/setup_harddisks_2/implementation/shdd2-parser	2007-11-11 10:54:45 UTC (rev 4711)
@@ -27,88 +27,6 @@
 # @brief A parser for the disk_config files within FAI, based on the EBNF
 # listed below. The implementation makes use of the RecDescent package.
 #
-# file ::= <lines> EOF
-#
-# lines ::= EOL
-#           /* empty lines or whitespace only */
-#           | <comment> EOL
-#           | <config> EOL
-#
-# comment ::= #.*
-#
-# config ::= disk_config lvm
-#            | disk_config raid
-#            | disk_config end
-#            | disk_config disk[[:digit:]]+( <option>)*
-#            | disk_config [^[:space:]]+( <option>)*
-#            /* fully qualified device-path or short form, like hda, whereby full
-#             * path is assumed to be /dev/hda */
-#            | <volume>
-#
-# option ::= /* empty */
-#            | preserve_always:[[:digit:]]+(,[[:digit:]]+)*
-#            /* preserve partitions -- always */
-#            | preserve_reinstall:[[:digit:]]+(,[[:digit:]]+)*
-#            /* preserve partitions -- unless the system is installed for the 
-#            first time */
-#            | resize:[[:digit:]]+(,[[:digit:]]+)*
-#            /* attempt to resize partitions */
-#            | disklabel:(msdos|gpt)
-#            /* write a disklabel - default is msdos */
-#            | bootable:[[:digit:]]+
-#            /* mark a partition bootable, default is / */
-#            | virtual
-#            /* do not assume the disk to be a physical device, use with xen */
-#            | fstabkey:(device|label|uuid)
-#            /* when creating the fstab, the key used for defining the device
-#            may be the device (/dev/xxx), a label given using -L, or the uuid
-#            */
-#
-# volume ::= <type> <mountpoint> <size> <filesystem> <mount_options> <fs_options>
-#            | vg <name> <size>
-#            /* lvm vg */
-#
-# type ::= primary
-#          /* for physical disks only */
-#          | logical
-#          /* for physical disks only */
-#          | raid[0156]
-#          /* raid level */
-#          | [^/[:space:]]+-[^/[:space:]]+
-#          /* lvm logical volume: vg name and lv name*/
-#
-# mountpoint ::= -
-#                /* do not mount */
-#                | swap
-#                /* swap space */
-#                | /[^[:space:]]*
-#                /* fully qualified path */
-#
-# name ::= [^/[:space:]]+
-#          /* lvm volume group name */
-#
-# size ::= [[:digit:]]+[kMGTP%]?(-([[:digit:]]+[kMGTP%]?)?)?(:resize)?
-#          /* size in kilo, mega (default), giga, tera or petabytes or %,
-#           * possibly given as a range; physical
-#           * partitions or lvm logical volumes only; */
-#          | -[[:digit:]]+[kMGTP%]?(:resize)?
-#          /* size in kilo, mega (default), giga, tera or petabytes or %,
-#           * given as upper limit; physical partitions
-#           * or lvm logical volumes only */
-#          | [^,:[:space:]]+(:(spare|missing))*(,[^,:[:space:]]+(:(spare|missing))*)*
-#          /* devices and options for a raid or lvm vg */
-#
-# mount_options ::= [^[:space:]]+
-#
-# filesystem ::= -
-#                | swap
-#                | [^[:space:]]
-#                /* mkfs.xxx must exist */
-#
-# fs_options ::= .*
-#                /* options appended to mkfs.xxx call */
-#
-#
 # $Id$
 #
 # @author Christian Kern, Michael Tautschnig, Sam Vilain, Andreas Schludei




More information about the Fai-commit mailing list