Subversion Repositories DevTools

Rev

Rev 357 | Rev 3347 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 357 Rev 361
Line 628... Line 628...
628
#   Documentation
628
#   Documentation
629
#
629
#
630
 
630
 
631
=pod
631
=pod
632
 
632
 
-
 
633
=for htmltoc    SYSUTIL::
-
 
634
 
633
=head1 NAME
635
=head1 NAME
634
 
636
 
635
jats_ccsave_build - Save a build view to version control system
637
jats_ccsave_build - Save a build view to version control system
636
 
638
 
637
=head1 SYNOPSIS
639
=head1 SYNOPSIS
Line 752... Line 754...
752
This utility is used by the automated build system to place build view under
754
This utility is used by the automated build system to place build view under
753
version control. The utility will:
755
version control. The utility will:
754
 
756
 
755
=over 8
757
=over 8
756
 
758
 
-
 
759
=item *
-
 
760
 
757
=item * Determine a suitable label for the package
761
Determine a suitable label for the package
758
 
762
 
759
The label is constructed from the package name and the package version. The
763
The label is constructed from the package name and the package version. The
760
utility will ensure that the label does not already exist. If it does it will
764
utility will ensure that the label does not already exist. If it does it will
761
use an alternate form of the label.
765
use an alternate form of the label.
762
 
766
 
-
 
767
=item *
-
 
768
 
763
=item * Determine a suitable branch name for the build files
769
Determine a suitable branch name for the build files
764
 
770
 
765
The modified build file is placed on a file-branch.
771
The modified build file is placed on a file-branch.
766
 
772
 
-
 
773
=item *
-
 
774
 
767
=item * Locate the build files within the package
775
Locate the build files within the package
768
 
776
 
769
JATS build files do not need to be at the root of the package. The utility
777
JATS build files do not need to be at the root of the package. The utility
770
will locate the JATS build files.
778
will locate the JATS build files.
771
 
779
 
-
 
780
=item *
-
 
781
 
772
=item * Update the build files and save them into the version control system
782
Update the build files and save them into the version control system
773
 
783
 
774
The build file will be updated with new version information as provided by a
784
The build file will be updated with new version information as provided by a
775
secondary configuration file.
785
secondary configuration file.
776
 
786
 
777
The updated file will be checked into version control. It will be placed on a
787
The updated file will be checked into version control. It will be placed on a
Line 781... Line 791...
781
can work around this - but its not done yet.
791
can work around this - but its not done yet.
782
 
792
 
783
If the build file is sourced from a different branch then a Merge arrow
793
If the build file is sourced from a different branch then a Merge arrow
784
will be created to indicate where the file and its label was taken from.   
794
will be created to indicate where the file and its label was taken from.   
785
 
795
 
-
 
796
=item *
-
 
797
 
786
=item * Ensure that the package is labeled
798
Ensure that the package is labeled
787
 
799
 
788
The build view will be labeled.
800
The build view will be labeled.
789
 
801
 
790
If a WIP label is provided then the label will be applied to the modified
802
If a WIP label is provided then the label will be applied to the modified
791
build file and then the label will be renamed.
803
build file and then the label will be renamed.
792
 
804
 
793
If a WIP label is not provided, then the entire package will be labeled with a
805
If a WIP label is not provided, then the entire package will be labeled with a
794
suitable label.
806
suitable label.
795
 
807
 
-
 
808
=item *
-
 
809
 
796
=item * Return the label to the user
810
Return the label to the user
797
 
811
 
798
The label used to label the package will be returned to the user in an 'info'
812
The label used to label the package will be returned to the user in an 'info'
799
file. This is a 'properties' file. The following properties are defined:
813
file. This is a 'properties' file. The following properties are defined:
800
 
814
 
801
=over 8
815
=over 8
802
 
816
 
-
 
817
=item   1
-
 
818
 
803
=item   1) Label - The label used to tag the file
819
Label - The label used to tag the file
-
 
820
 
-
 
821
=item   2
-
 
822
 
-
 
823
PackageName - The package name
804
 
824
 
805
=item   2) PackageName - The package name
825
=item   3
806
 
826
 
807
=item   3) PackageVersion - The package version
827
PackageVersion - The package version
808
 
828
 
809
=back
829
=back
810
 
830
 
811
=back
831
=back
812
 
832