X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=Tools%2FXMLSchema%2FNamingConvention.xsd;h=936b6f2741a9e03e7f3058b69667bec9287ae46d;hp=99e28e307ee050d32aa4da544fc974bb951575b9;hb=d2f9b39f43b4bc4890a77f44c72cc6ffc1ee48a0;hpb=2bf4e0a1637708b2dc049e043c2a6343e6518f36 diff --git a/Tools/XMLSchema/NamingConvention.xsd b/Tools/XMLSchema/NamingConvention.xsd index 99e28e307e..936b6f2741 100644 --- a/Tools/XMLSchema/NamingConvention.xsd +++ b/Tools/XMLSchema/NamingConvention.xsd @@ -1,6 +1,6 @@ - + + This schema defines various data types and naming conventions including: base name, filename and directory naming conventions. These are all simple data types. + + - This schema defines various data types and naming conventions including: base name, filename and directory naming conventions. These are all simple data types. + C_Names must start with either an underscore (_) character followed by one or more alpha characters, followed by any combination of underscore or alphanumeric characters. - - - Base Names must start with an upper case character, followed by one or more alphanumeric characters and/or an optional underscore (_) character followed by one or more alphanumeric characters. Examples: Base_name3, BASE_NAME3, BaseName3 - - - - - - - - C_Names must start with either an underscore (_) character followed by one or more alpha characters, followed by any combination of underscore or alphanumeric characters. - - - - - - - - Directory naming convention is a UNION of DOS an UNIX directory path names - - - - - - Directory naming convention for Windows backslash (\) directory path name - - - - - - - - Directory naming convention for UNIX forwardslash (/) directory path name - - - - - - - - - - - - - This defines what a Filename is: Alphanumeric characters and optional underscore (_) or dash (-) characters, followed by a optional dot and more alphanumeric characters. - - - - - - - - This defines the minimum specification for a GUID Array which is 8 Hex Digits - 4 Hex Digits - 4 Hex Digits - 8 Hex Bytes, the last 16 Hex Digits can be enclosed in sqiggle {} brackets. - - - - - - - - C_Names must start with either an underscore (_) character followed by one or more alpha characters, followed by any combination of underscore or alphanumeric characters. - - - - - - - - A GUID must contain five different Hexadecimal character sets that are separated by a dash (-) character. - - - - - - - - The GUID data is union of GuidNaming Convetion and GuidArrayType. - - - - - - Define a Hex 64 Bit Value to be 0x[a-f0-9]{16} - - - - - - - - Define a Hex Address, 0x[a-fA-F0-9]{1,16} - - - - - - - - Define a Hex Byte Value to be 0x[a-f0-9]{2} - - - - - - - - Define a Hex Value to be 0x[a-f0-9]+ - - - - - - - - Define a Hex Diget to be 0x[a-f0-9] - - - - - - - - Define a Hex Double Word Value to be 0x[a-f0-9]{8} - - - - - - - - Define a Hex Word Value to be 0x[a-f0-9]{4} - - - - - - - - This defines what a Library name is: alphanumeric characters and optional underscore (_) characters. - - - - - - - - What is a name, any series of alphanumeric characters and one or more underline characters that may occur in any position - - - - - - - - This describes the normal text of a paragraph that can be used in a license or description tag. - - - - - - Naming convention for a path and file name - - - - - - This defines what a Platform Name is: Alphanumeric characters and optional underscore (_) or dash (-) characters, followed by a dot and more alphanumeric characters. - - - - - - - - Limit Polarity vaild values to -1, 0 and 1 - - - - - - - - This data type requires two or more words - - - - - - - - This defines what a Tool name is: Alphanumeric characters and optional underscore (_) or dash (-) characters, optionally followed by a dot and more alphanumeric characters. - - - - - - - - Definition of a UpperCase Letter type, which can be any combination of upper case characters followed by zero or more underscore and/or uppercase alphanumeric characters - - - - - - - - Definition of a UpperCase Name, which can be any combination of upper case characters followed by zero or more underscore and/or uppercase alphanumeric characters - - - - - - - - Specify a User Name - - - - - - - - %VAR%(Directory)*(File_Names)* - - - - - - - - ($VAR | $( VAR) | ${VAR})(Directory)*(File_Names) - - - - - - - - VariableConvention is a UNION of: $VAR, $( VAR), ${VAR} and %VAR% and Directory and File Names - - - - - - The GUID data is union of GuidNaming Convetion and GuidArrayType. - - - - - - VariableConvention is a UNION of: $VAR, $( VAR), ${VAR} and %VAR% - - - - - - Definition of a DOS Variable Name: %VAR% It must start with an Upper Case character. - - - - - - - - Definition of a UNIX Variable Name: $VAR It must start with an Upper Case character. - - - - - - - - Definition of a UNIX Variable Name: $( VAR1) It must start with an Upper Case character. - - - - - - - - Definition of a UNIX Variable Name: ${ VAR1} It must start with an Upper Case character. - - - - - - - - Definition of a Version Number, which can be any combination of a number followed by zero or more alphanumeric-dot-alphanumeric characters - - - - - - - - Define Zero as a vaild value - - - - - - - - Definition of a Version Number, which can be any combination of a number followed by zero or more alphanumeric-dot-alphanumeric characters - - - - - + + + + + + + This defines what a Filename is: Alphanumeric characters and optional underscore (_) or dash (-) characters, followed by a optional dot and more alphanumeric characters. + + + + + + + + The GUID data was a union of GuidType1 and GuidType2; standardizing on GuidType2. + + + + + + This defines the minimum specification for a GUID Array which is 8 Hex Digits - 4 Hex Digits - 4 Hex Digits - 8 Hex Bytes, the last 16 Hex Digits can be enclosed in sqiggle {} brackets. + + + + + + + + A GUID must contain five different Hexadecimal character sets that are separated by a dash (-) character. + + + + + + + + Define a Hex 64 Bit Value to be 0x[a-f0-9]{16} + + + + + + + + Define a Hex Address, 0x[a-fA-F0-9]{1,16} + + + + + + + + Define a Hex Byte Value to be 0x[a-f0-9]{2} + + + + + + + + Define a Hex Value to be 0x[a-f0-9]+ + + + + + + + + Define a Hex Diget to be 0x[a-f0-9] + + + + + + + + Define a Hex Double Word Value to be 0x[a-f0-9]{8} + + + + + + + + Define a Hex Word Value to be 0x[a-f0-9]{4} + + + + + + + + + + + + + + + + + + + This describes the normal text of a paragraph that can be used in a license or description tag. + + + + + + Naming convention for a path and file name + + + + + + Limit Polarity vaild values to 0 and 1 + + + + + + + + This data type requires two or more words + + + + + + + + This data type is used for ToolCommand, ToolChainFamily and TagName. + + + + + + + + Definition of a UpperCase Name, which can be any combination of upper case characters followed by zero or more underscore and/or uppercase alphanumeric characters + + + + + + + + Definition of a Version Number, which is one or more strings of decimal digits separated by dots. + + The algorithm to compare two versions A and B is as follows. if A==B, then A is the same version as B. Otherwise, say A is a1.a2.a3...an and B is b1.b2.b3...bn. For the first pair (ai, bi), for i less than n and i less than m, where ai is not equal to bi, if ai is less than bi, then A is less than B. If ai is greater than bi, then A is greater than B. + + + + + + + + + Define Zero as a vaild value + + + + +