<!--

CDDL HEADER START

The contents of this file are subject to the terms of the

Common Development and Distribution License (the "License").

You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE

or http://www.opensolaris.org/os/licensing.

See the License for the specific language governing permissions

and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each

file and include the License file at usr/src/OPENSOLARIS.LICENSE.

If applicable, add the following below this CDDL HEADER, with the

fields enclosed by brackets "[]" replaced with your own identifying

information: Portions Copyright [yyyy] [name of copyright owner]

CDDL HEADER END

Copyright 2010 Sun Microsystems, Inc.  All rights reserved.

Use is subject to license terms.

-->

<!--

===============================================================================

RelaxNG schema for Distribution Constructor input manifest specification.

Contains schema rules and content specification for DC input manifest.

				===Warning===

This file must be kept in sync with the defval-manifest.  When items are

added/removed to/from this schema, there may be changes to the list of items

requiring validation or defaults.

				===Warning===

===============================================================================

-->

<grammar

    xmlns="http://relaxng.org/ns/structure/1.0"

    datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">

	<!--

	=======================================================================

	Top o' the tree

	=======================================================================

	-->

	<start>

		<element name="distribution">

			<attribute name="name"/>

			<!-- General distro-constructor parameters -->

			<ref name="nm_distro_constr_params"/>

			<choice>

				<!-- Parameters for building live image -->

				<ref name="nm_img_params"/>

				<!-- Parameters for building VM image -->

				<ref name="nm_vmimg_params"/>

			</choice>

			<!-- General key-value pairs -->

			<ref name="nm_key_value_pairs"/>

		</element>

	</start>

	<!--

	=======================================================================

	Parameters dealing with how the distro-constructor works.

	=======================================================================

	-->

	<define name="nm_distro_constr_params">

		<element name="distro_constr_params">

		<interleave>	<!-- Any element order is OK. -->

			<!-- Directory to build the pkg-image area in.

			     Will be created if it doesn't exist. -->

			<element name="build_area">

				<text/>	<!-- dirpath -->

			</element>

			<!-- Flags controlling DC execution. -->

			<ref name="nm_distro_constr_flags"/>

			<!--  Parameters specific to different output images -->

			<oneOrMore>

				<ref name="nm_output_image"/>

			</oneOrMore>

		</interleave>

		</element>

	</define>

	<define name="nm_distro_constr_flags">

		<element name="distro_constr_flags">

		<interleave>

			<!-- Stop when an error is encountered, including in

			     scripts/functions/programs run by the finalizer.-->

			<optional>	<!-- Default is true. -->

				<element name="stop_on_error">

					<data type="boolean"/>

				</element>

			</optional>

			<!-- Enable checkpointing, or saving snapshots of the

			     pkg image area at various (but specified)

			     points -->

			<optional>	<!-- Default is true. -->

				<ref name="nm_checkpointing"/>

			</optional>

		</interleave>

		</element>

	</define>

	<define name="nm_checkpointing">

		<element name="checkpoint_enable">

			<data type="boolean"/>

			<!-- Which checkpt to resume from. -->

			<!-- Default is 0 (beginning)-->

			<optional>

				<attribute name= "resume_from">

					<text/>

				</attribute>

			</optional>

		</element>

	</define>

	<!--

	=======================================================================

	=======================================================================

	Definitions / specifications for the live image parameters.

	=======================================================================

	=======================================================================

	-->

	<!--

	=======================================================================

	"Top" section for live image parameters.  This section describes how to

	build the medium's bootable live image.

	=======================================================================

	-->

	<define name="nm_img_params">

		<element name="img_params">

		<interleave>

			<!-- Main (default) repo (and it's mirrors) to get

			     packages for live image and optional on-board repo.

			     FMRIs without an explicit authority will be

			     sought-for here.  -->

			<element name="pkg_repo_default_authority">

				<ref name="nm_pkg_repo_contents"/>

			</element>

			<!-- Aliases for additional repos, where to find

			     packages not in main repo.  Packages using one of

			     these aliases must spell the alias out as part of

			     the package FMRI.  It is called an alias because it

			     instructs DC to search through a prefered repo

			     (same name as the alias itself) and then mirror

			     repos if necessary. -->

			<zeroOrMore>

				<element name="pkg_repo_addl_authority">

					<ref name="nm_pkg_repo_contents"/>

				</element>

			</zeroOrMore>

			<!-- The default repo (and it's mirrors) for the system

			    to use after the install has completed.  -->

			<optional>

				<element name="post_install_repo_default_authority">

					<ref name="nm_pkg_repo_contents"/>

				</element>

			</optional>

			<!-- Additional repos (and their mirrors) for the system

			    to use after the install has completed.  -->

			<zeroOrMore>

				<element name="post_install_repo_addl_authority">

					<ref name="nm_pkg_repo_contents"/>

				</element>

			</zeroOrMore>

			<!-- List of packages from which live image is built.

			     Package name can the name of an IPS incorporation

			     if such incorporation is in the source repository.

			     Package attributes and file tags help refine what

			     will actually be included. -->

			<element name="packages">

				<oneOrMore>

					<ref name="nm_pkg"/>

				</oneOrMore>

			</element>

			<!-- List of packages to remove after all packages

			     specified in the "packages" section are

			     installed into the package image area.  

			     Package name can the name of an IPS incorporation

			     if such incorporation is in the source repository.

			     Package attributes and file tags help refine what

			     will actually be included. -->

			<optional>

				<element name="post_install_remove_packages">

					<oneOrMore>

						<ref name="nm_pkg"/>

					</oneOrMore>

				</element>

			</optional>

			<!-- Indicate whether the IPS index should be generated

			     for pkg install and uninstall.  The default

			     is to not generate the IPS search index -->

			<optional>	<!-- Default is false. -->

				<element name="generate_ips_search_index">

					<data type="boolean"/>

				</element>

			</optional>

			<!-- The password used for the root user/role. -->

                        <optional>

				<element name="rootpass">

                                        <!-- Indicate whether the given

					     password is in plaintext or not.

                                             The default is True

                                        -->

					<attribute name="is_plaintext">

                                            <data type="boolean"/>

					</attribute>

					<text/>

				</element>

                        </optional>

			<!-- Files to be included in the boot archive of all media

			     delivered by this distribution.  Boot archive contains

			     the minimal list of contents in order to be able to

			     boot and setup a running system. -->

			<ref name="nm_boot_archive_contents"/>

			<!-- If/how to compress live image. -->

                        <optional>

				<element name="live_img_compression">

                               		<ref name="nm_live_img_compression"/>

				</element>

                        </optional>

			<!-- Hostname -->

			<element name="hostname">

				<text/>

			</element>

			<!-- All things locale-specific. -->

			<optional>	<!-- Posix/C always there -->

				<ref name="nm_locale"/>

			</optional>

			<!-- Users -->

			<ref name="nm_root_user"/>

			<zeroOrMore>

				<ref name="nm_user"/>

			</zeroOrMore>

			<!-- grub menu modifications. -->

			<optional>	<!-- If not specified,

					     use regular menu.lst -->

				<ref name="nm_grub_menu_mods"/>

			</optional>

			<!-- SMF profile defining which net services get

			     started at boottime.  Note: Use one of

			     /var/svc/profile/generic_limited_net.xml or

			     /var/svc/profile/generic_open.xml which define the

			     two configurations delivered with Solaris, or use

			     your own. -->

			<optional> <!-- generic_limited_net.xml if not spec -->

				<element name="netservices_SMF_profile">

					<text/>	<!-- filepath -->

				</element>

			</optional>

			<!-- power management. -->

			<optional>	<!-- Default is disabled -->

				<ref name="nm_power_mgmt"/>

			</optional>

			<!-- Limit of how large the pkg image area can grow.

			     Zero is unlimited. -->

			<optional>

				<!-- Default is unlimited.  Units are GB -->

				<element name="pkg_image_area_max_size_gb">

					<data type="float"/>

				</element>

			</optional>

		</interleave>

		</element>

	</define>

	<!--

	=======================================================================

	"Top" section for VM image parameters.  This section describes how to

	build a VM image.

	=======================================================================

	-->

	<define name="nm_vmimg_params">

		<element name="vmimg_params">

			<empty/>

		</element>

	</define>

	<!--

	=======================================================================

	Grub menu modifications

	=======================================================================

	-->

	<define name="nm_grub_menu_mods">

		<element name="grub_menu_modifications">

			<interleave>

				<optional>

					<element name="min_mem64">

						<data type="unsignedLong"/>

					</element>

				</optional>

				<optional>

					<element name="title">

						<text/>

					</element>

				</optional>

				<optional>

					<element name="default_entry">

						<data type="unsignedInt"/>

					</element>

				</optional>

				<optional>

					<element name="timeout">

						<data type="unsignedInt"/>

					</element>

				</optional>

				<zeroOrMore>

					<ref name="nm_grub_entry"/>

				</zeroOrMore>

			</interleave>

		</element>

	</define>

	<define name="nm_grub_entry">

		<element name="entry">

			<optional>

				<attribute name="position">

					<data type="unsignedInt"/>

				</attribute>

			</optional>

			<element name="title_suffix">

				<text/>

			</element>

			<oneOrMore>

				<element name="line">

					<text/>

				</element>

			</oneOrMore>

		</element>

	</define>

	<!--

	=======================================================================

	Boot archive content specification.  Start with a base list of files

	to put into the boot archive.  Then adjust this list by adding and deleting

	individual files as adjustments.

	Base list is not to be changed;  make changes through adjustments.

	This is to provide a better record of what changes are made for

	specific distibutions,which may be important for debugging purposes.

	GUIs should honor this and only add to the adjustments list.

	=======================================================================

	-->

	<define name="nm_boot_archive_contents">

		<element name="boot_archive_contents">

			<interleave>

				<oneOrMore>

					<ref name="nm_base_include"/>

				</oneOrMore>

				<zeroOrMore>

					<element name="base_exclude">

						<ref name="nm_excltype_attr"/>

						<text/>

					</element>

				</zeroOrMore>

				<zeroOrMore>

					<ref name="nm_adjustment"/>

				</zeroOrMore>

			</interleave>

		</element>

	</define>

	<!--

	Files to be included may be specified as individual files or as

	directories of files.  On some platforms per-file compression is done by

	default.  This can be disabled on individual files which are read in as

	part of a directory of files, by base_include'ing that file and

	specifying fiocompress="false" for it.

	-->

	<define name="nm_base_include">

		<element name="base_include">

			<choice>

				<!-- Can be either files or dirs,

					but files allow more attributes. -->

				<ref name="nm_inclfiletype_attr"/>

				<ref name="nm_incldirtype_attr"/>

			</choice>

			<text/>

		</element>

	</define>

	<define name="nm_inclfiletype_attr">

		<group>

			<!-- In the case of "type = file", allow fiocompress -->

			<attribute name="type">

				<choice>

					<value>file</value>

				</choice>

			</attribute>

			<optional>

				<attribute name="fiocompress">

					<data type="boolean"/>

				</attribute>

			</optional>

		</group>

	</define>

	<define name="nm_incldirtype_attr">

		<group>

			<attribute name="type">

				<choice>

					<value>dir</value>

				</choice>

			</attribute>

		</group>

	</define>

	<define name="nm_excltype_attr">

		<group>

			<attribute name="type">

				<choice>

					<value>file</value>

					<value>dir</value>

				</choice>

			</attribute>

		</group>

	</define>

	<!--

	=======================================================================

	Selections for live image compression parameters.  Includes type and

	level.  Keep separate from other sets of compression parameters to

	allow for other options available only to live images.

	=======================================================================

	-->

	<define name="nm_live_img_compression">

		<!-- enum of gzip, none -->

		<attribute name="type">

			<choice>

				<value>gzip</value>

				<value>lzma</value>

				<value>none</value>

			</choice>

		</attribute>

		<attribute name="level">

			<data type="unsignedByte"/>

		</attribute>

	</define>

	<!--

	=======================================================================

	Selections for boot archive compression parameters.  Includes type and

	level.  Keep separate from other sets of compression parameters to

	allow for other options available only to boot archives.

	=======================================================================

	-->

	<define name="nm_boot_archive_compression">

		<!-- enum of gzip, none -->

		<attribute name="type">

			<choice>

				<value>gzip</value>

				<value>none</value>

			</choice>

		</attribute>

		<attribute name="level">

			<data type="unsignedByte"/>

		</attribute>

	</define>

	<!--

	=======================================================================

	Output image processing

	=======================================================================

	-->

	<define name="nm_output_image">

		<element name="output_image">

			<interleave>

				<!-- Tweeks to the boot archive specific for this

				     output image. -->

				<optional> <!-- Maybe generic boot archive is fine -->