Grammar fixes for doc strings
This commit is contained in:
parent
b3dc48d241
commit
8d0df28296
@ -37,106 +37,106 @@ class KiwiError(Exception):
|
||||
|
||||
class KiwiArchiveSetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if an unsupported image archive type is used
|
||||
Exception raised if an unsupported image archive type is used.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiBootImageSetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if an unsupported initrd system type is used
|
||||
Exception raised if an unsupported initrd system type is used.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiBootLoaderConfigSetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if a configuration for an unsupported
|
||||
bootloader is requested
|
||||
bootloader is requested.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiBootLoaderGrubDataError(KiwiError):
|
||||
"""
|
||||
Exception raised if no grub installation was found
|
||||
Exception raised if no grub installation was found.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiBootLoaderGrubFontError(KiwiError):
|
||||
"""
|
||||
Exception raised if no grub unicode font was found
|
||||
Exception raised if no grub unicode font was found.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiBootLoaderGrubInstallError(KiwiError):
|
||||
"""
|
||||
Exception raised if grub install to master boot record has failed
|
||||
Exception raised if grub install to master boot record has failed.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiBootLoaderGrubModulesError(KiwiError):
|
||||
"""
|
||||
Exception raised if the synchronisation of modules from the
|
||||
grub installation to the boot space has failed
|
||||
grub installation to the boot space has failed.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiBootLoaderGrubPlatformError(KiwiError):
|
||||
"""
|
||||
Exception raised if an attempt was made to use grub on an
|
||||
unsupported platform
|
||||
unsupported platform.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiBootLoaderInstallSetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if an installation for an unsupported
|
||||
bootloader is requested
|
||||
bootloader is requested.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiBootLoaderIsoLinuxPlatformError(KiwiError):
|
||||
"""
|
||||
Exception raised if an attempt was made to use isolinux on
|
||||
an unsupported platform
|
||||
an unsupported platform.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiBootLoaderTargetError(KiwiError):
|
||||
"""
|
||||
Exception raised if the target to read the bootloader path
|
||||
from is not a disk or an iso image
|
||||
from is not a disk or an iso image.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiBootLoaderZiplInstallError(KiwiError):
|
||||
"""
|
||||
Exception raised if the installation of zipl has failed
|
||||
Exception raised if the installation of zipl has failed.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiBootLoaderZiplPlatformError(KiwiError):
|
||||
"""
|
||||
Exception raised if a configuration for an unsupported
|
||||
zipl architecture is requested
|
||||
zipl architecture is requested.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiBootLoaderZiplSetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if the data set to configure the zipl
|
||||
bootloader is incomplete
|
||||
bootloader is incomplete.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiBootStrapPhaseFailed(KiwiError):
|
||||
"""
|
||||
Exception raised if the bootstrap phase of the system prepare
|
||||
command has failed
|
||||
command has failed.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiBundleError(KiwiError):
|
||||
"""
|
||||
Exception raised if the system bundle command has failed
|
||||
Exception raised if the system bundle command has failed.
|
||||
"""
|
||||
|
||||
|
||||
@ -144,90 +144,90 @@ class KiwiCommandError(KiwiError):
|
||||
"""
|
||||
Exception raised if an external command called via a Command
|
||||
instance has returned with an exit code != 0 or could not
|
||||
be called at all
|
||||
be called at all.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiCommandNotLoaded(KiwiError):
|
||||
"""
|
||||
Exception raised if a kiwi command task module could not be
|
||||
loaded
|
||||
loaded.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiCompressionFormatUnknown(KiwiError):
|
||||
"""
|
||||
Exception raised if the compression format of the data could
|
||||
not be detected
|
||||
not be detected.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiCompatError(KiwiError):
|
||||
"""
|
||||
Exception raised if the given kiwi compatibility command line
|
||||
could not be understood by the compat option parser
|
||||
could not be understood by the compat option parser.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiConfigFileNotFound(KiwiError):
|
||||
"""
|
||||
Exception raised if no kiwi XML description was found
|
||||
Exception raised if no kiwi XML description was found.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiContainerSetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if an error in the creation of the
|
||||
container archive happened
|
||||
container archive happened.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiContainerImageSetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if an attempt to create a container instance
|
||||
for an unsupported container type is performed
|
||||
for an unsupported container type is performed.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiDataStructureError(KiwiError):
|
||||
"""
|
||||
Exception raised if the XML description failed to parse the
|
||||
data structure
|
||||
data structure.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiDebootstrapError(KiwiError):
|
||||
"""
|
||||
Exception raised if not enough user data to call debootstrap
|
||||
were provided or the debootstrap has failed
|
||||
were provided or the debootstrap has failed.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiDescriptionInvalid(KiwiError):
|
||||
"""
|
||||
Exception raised if the XML description failed to validate
|
||||
the XML schema
|
||||
the XML schema.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiDeviceProviderError(KiwiError):
|
||||
"""
|
||||
Exception raised if a storage provide is asked for its
|
||||
managed device but no such device exists
|
||||
managed device but no such device exists.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiDiskBootImageError(KiwiError):
|
||||
"""
|
||||
Exception raised if a kiwi boot image does not provide the
|
||||
requested data, e.g kernel, or hypervisor files
|
||||
requested data, e.g kernel, or hypervisor files.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiDiskFormatSetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if an attempt was made to create a disk format
|
||||
instance of an unsupported disk format
|
||||
instance of an unsupported disk format.
|
||||
"""
|
||||
|
||||
|
||||
@ -235,77 +235,77 @@ class KiwiDiskGeometryError(KiwiError):
|
||||
"""
|
||||
Exception raised if the disk geometry (partition table) could
|
||||
not be read or evaluated against their expected geometry and
|
||||
capabilities
|
||||
capabilities.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiDistributionNameError(KiwiError):
|
||||
"""
|
||||
Exception raised if the distribution name could not be found
|
||||
Exception raised if the distribution name could not be found.
|
||||
The information is extracted from the boot attribute of the
|
||||
XML description, if no boot attribute is present or does not
|
||||
match the naming conventions the exception is raised
|
||||
XML description. If no boot attribute is present or does not
|
||||
match the naming conventions the exception is raised.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiFileNotFound(KiwiError):
|
||||
"""
|
||||
Exception raised if the requested file could not be found
|
||||
Exception raised if the requested file could not be found.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiFileSystemSetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if an attempt was made to build an
|
||||
unsupported or unspecified filesystem
|
||||
unsupported or unspecified filesystem.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiFileSystemSyncError(KiwiError):
|
||||
"""
|
||||
Exception raised if the data sync from the system into the
|
||||
loop mounted filesystem image failed
|
||||
loop mounted filesystem image failed.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiFormatSetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if the requested disk format could not be created
|
||||
Exception raised if the requested disk format could not be created.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiHelpNoCommandGiven(KiwiError):
|
||||
"""
|
||||
Exception raised if the request for the help page is
|
||||
executed without a command to show the help for
|
||||
executed without a command to show the help for.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiImportDescriptionError(KiwiError):
|
||||
"""
|
||||
Exception raised if the XML description data and scripts could
|
||||
not be imported into the root of the image
|
||||
not be imported into the root of the image.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiInstallBootImageError(KiwiError):
|
||||
"""
|
||||
Exception raised if the required files to boot an installation
|
||||
image could not be found, e.g kernel or hypervisor
|
||||
image could not be found, e.g kernel or hypervisor.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiInstallMediaError(KiwiError):
|
||||
"""
|
||||
Exception raised if a request for an installation media is made
|
||||
but the system image type is not an oem type
|
||||
but the system image type is not an oem type.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiInstallPhaseFailed(KiwiError):
|
||||
"""
|
||||
Exception raised if the install phase of a system prepare command
|
||||
has failed
|
||||
has failed.
|
||||
"""
|
||||
|
||||
|
||||
@ -313,13 +313,13 @@ class KiwiInvalidVolumeName(KiwiError):
|
||||
"""
|
||||
Exception raised if the name of a volume contains invalid
|
||||
characters according to the volume system and kiwi internal
|
||||
rules
|
||||
rules.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiIsoLoaderError(KiwiError):
|
||||
"""
|
||||
Exception raised if no isolinux loader file could be found
|
||||
Exception raised if no isolinux loader file could be found.
|
||||
"""
|
||||
|
||||
|
||||
@ -327,203 +327,203 @@ class KiwiIsoMetaDataError(KiwiError):
|
||||
"""
|
||||
Exception raised if an inconsistency in the ISO header
|
||||
was found such like invalid eltorito specification or a
|
||||
broken path table
|
||||
broken path table.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiIsoToolError(KiwiError):
|
||||
"""
|
||||
Exception raised if an iso helper tool such as isoinfo
|
||||
could not be found on the build system
|
||||
could not be found on the build system.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiLiveBootImageError(KiwiError):
|
||||
"""
|
||||
Exception raised if an attempt was made to use an
|
||||
unsupported live iso type
|
||||
unsupported live iso type.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiLuksSetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if not enough user data is provided to
|
||||
setup the luks encryption on the given device
|
||||
setup the luks encryption on the given device.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiLoadCommandUndefined(KiwiError):
|
||||
"""
|
||||
Exception raised if no command is specified for a given
|
||||
service on the commandline
|
||||
service on the commandline.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiLogFileSetupFailed(KiwiError):
|
||||
"""
|
||||
Exception raised if the log file could not be created
|
||||
Exception raised if the log file could not be created.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiLoopSetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if not enough user data to create a
|
||||
loop device is specified
|
||||
loop device is specified.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiMappedDeviceError(KiwiError):
|
||||
"""
|
||||
Exception raised if the device to become mapped does not exist
|
||||
Exception raised if the device to become mapped does not exist.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiMountKernelFileSystemsError(KiwiError):
|
||||
"""
|
||||
Exception raised if a kernel filesystem such as proc or sys
|
||||
could not be mounted
|
||||
could not be mounted.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiMountSharedDirectoryError(KiwiError):
|
||||
"""
|
||||
Exception raised if the host <-> image shared directory
|
||||
could not be mounted
|
||||
could not be mounted.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiNotImplementedError(KiwiError):
|
||||
"""
|
||||
Exception raised if a functionality is not yet implemented
|
||||
Exception raised if a functionality is not yet implemented.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiPackageManagerSetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if an attempt was made to create a package
|
||||
manager instance for an unsupported package manager
|
||||
manager instance for an unsupported package manager.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiPartitionerGptFlagError(KiwiError):
|
||||
"""
|
||||
Exception raised if an attempt was made to set an unknown
|
||||
partition flag for an entry in the GPT table
|
||||
partition flag for an entry in the GPT table.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiPartitionerMsDosFlagError(KiwiError):
|
||||
"""
|
||||
Exception raised if an attempt was made to set an unknown
|
||||
partition flag for an entry in the MSDOS table
|
||||
partition flag for an entry in the MSDOS table.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiPartitionerSetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if an attempt was made to create an instance
|
||||
of a partitioner for an unsupporte partitioner
|
||||
of a partitioner for an unsupporte partitioner.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiPrivilegesError(KiwiError):
|
||||
"""
|
||||
Exception raised if root privileges are required but not granted
|
||||
Exception raised if root privileges are required but not granted.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiProfileNotFound(KiwiError):
|
||||
"""
|
||||
Exception raised if a specified profile does not exist in the
|
||||
XML configuration
|
||||
XML configuration.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiPxeBootImageError(KiwiError):
|
||||
"""
|
||||
Exception raised if a required boot file e.g the kernel could
|
||||
not be found in the process of building a pxe image
|
||||
not be found in the process of building a pxe image.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiRaidSetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if invalid or not enough user data is provided
|
||||
to create a raid array on the specified storage device
|
||||
to create a raid array on the specified storage device.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiRepositorySetupError(KiwiError):
|
||||
"""
|
||||
Exception raised if an attempt was made to create an instance of
|
||||
a repository for an unsupported package manager
|
||||
a repository for an unsupported package manager.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiRepoTypeUnknown(KiwiError):
|
||||
"""
|
||||
Exception raised if an unsupported repository type is specified
|
||||
for the corresponding package manager
|
||||
for the corresponding package manager.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiRequestedTypeError(KiwiError):
|
||||
"""
|
||||
Exception raised if an attempt was made to build an image for
|
||||
an unsupported image type
|
||||
an unsupported image type.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiRequestError(KiwiError):
|
||||
"""
|
||||
Exception raised if a package request could not be processed by
|
||||
the corresponding package manager instance
|
||||
the corresponding package manager instance.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiResultError(KiwiError):
|
||||
"""
|
||||
Exception raised if the image build result pickle information
|
||||
could not be created or loaded
|
||||
could not be created or loaded.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiRootDirExists(KiwiError):
|
||||
"""
|
||||
Exception raised if the specified image root directory already
|
||||
exists and should not be re-used
|
||||
exists and should not be re-used.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiRootInitCreationError(KiwiError):
|
||||
"""
|
||||
Exception raised if the initialization of a new image root
|
||||
directory has failed
|
||||
directory has failed.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiRpmDatabaseReloadError(KiwiError):
|
||||
"""
|
||||
Exception raised on error of an rpm DB dump -> reload process
|
||||
Exception raised on error of an rpm DB dump -> reload process.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiRuntimeError(KiwiError):
|
||||
"""
|
||||
Exception raised if a runtime check has failed
|
||||
Exception raised if a runtime check has failed.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiSchemaImportError(KiwiError):
|
||||
"""
|
||||
Exception raised if the schema file could not be read
|
||||
by lxml.RelaxNG
|
||||
by lxml.RelaxNG.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiScriptFailed(KiwiError):
|
||||
"""
|
||||
Exception raised if a user script returned with an exit code != 0
|
||||
Exception raised if a user script returned with an exit code != 0.
|
||||
"""
|
||||
|
||||
|
||||
@ -531,96 +531,96 @@ class KiwiSetupIntermediateConfigError(KiwiError):
|
||||
"""
|
||||
Exception raised if the setup of the temporary image system
|
||||
configuration for the duration of the build process has
|
||||
failed
|
||||
failed.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiSystemDeletePackagesFailed(KiwiError):
|
||||
"""
|
||||
Exception raised if the deletion of a package has failed in
|
||||
the corresponding package manager instance
|
||||
the corresponding package manager instance.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiSystemInstallPackagesFailed(KiwiError):
|
||||
"""
|
||||
Exception raised if the installation of a package has failed in
|
||||
the corresponding package manager instance
|
||||
the corresponding package manager instance.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiSystemUpdateFailed(KiwiError):
|
||||
"""
|
||||
Exception raised if the package upgrade has failed in
|
||||
the corresponding package manager instance
|
||||
the corresponding package manager instance.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiTargetDirectoryNotFound(KiwiError):
|
||||
"""
|
||||
Exception raised if the specified target directory to store
|
||||
the image results was not found
|
||||
the image results was not found.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiTemplateError(KiwiError):
|
||||
"""
|
||||
Exception raised if the substitution of variables in a
|
||||
configuration file template has failed
|
||||
configuration file template has failed.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiTypeNotFound(KiwiError):
|
||||
"""
|
||||
Exception raised if no build type was found in the XML description
|
||||
Exception raised if no build type was found in the XML description.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiUnknownServiceName(KiwiError):
|
||||
"""
|
||||
Exception raised if an unknown service name was provided
|
||||
on the commandline
|
||||
on the commandline.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiUriStyleUnknown(KiwiError):
|
||||
"""
|
||||
Exception raised if an unsupported URI style was used in the
|
||||
source definition of a repository
|
||||
source definition of a repository.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiUriTypeUnknown(KiwiError):
|
||||
"""
|
||||
Exception raised if the protocol type of an URI is unknown
|
||||
in the source definition of a repository
|
||||
in the source definition of a repository.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiValidationError(KiwiError):
|
||||
"""
|
||||
Exception raised if the XML validation against the schema has failed
|
||||
Exception raised if the XML validation against the schema has failed.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiVhdTagError(KiwiError):
|
||||
"""
|
||||
Exception raised if the GUID tag is not provided in the
|
||||
expected format
|
||||
expected format.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiVmdkToolsError(KiwiError):
|
||||
"""
|
||||
Exception raised if the version information from vmtoolsd does
|
||||
not match the expected output format
|
||||
not match the expected output format.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiVolumeGroupConflict(KiwiError):
|
||||
"""
|
||||
Exception raised if the requested LVM volume group already is
|
||||
in use on the build system
|
||||
in use on the build system.
|
||||
"""
|
||||
|
||||
|
||||
@ -629,12 +629,12 @@ class KiwiVolumeManagerSetupError(KiwiError):
|
||||
Exception raised if the preconditions for volume mangement
|
||||
support are not met or an attempt was made to create an
|
||||
instance of a volume manager for an unsupported volume
|
||||
management system
|
||||
management system.
|
||||
"""
|
||||
|
||||
|
||||
class KiwiVolumeRootIDError(KiwiError):
|
||||
"""
|
||||
Exception raised if the root volume can not be found. This
|
||||
concept currently exists only for the btrfs subvolume system
|
||||
concept currently exists only for the btrfs subvolume system.
|
||||
"""
|
||||
|
||||
Loading…
Reference in New Issue
Block a user