]> git.e2factory.org Git - e2factory.git/commitdiff
manual pages: document sha256 attribute
authorTobias Ulmer <tu@emlix.com>
Thu, 22 Dec 2016 19:57:14 +0000 (20:57 +0100)
committerTobias Ulmer <tu@emlix.com>
Thu, 22 Dec 2016 19:57:14 +0000 (20:57 +0100)
Signed-off-by: Tobias Ulmer <tu@emlix.com>
doc/man/e2chroot.5.in
doc/man/e2licence.5.in
doc/man/e2source.5.in

index 8cabb7c0da693c8b61a0511b7db1224d91cdf8bf..4bd0d3a8be5fd5bd5f4dd187559843cf247134f5 100644 (file)
@@ -1,8 +1,8 @@
 .\" Man page for e2chroot
 .\"
-.\" (c)2007, 2012 emlix GmbH
+.\" (c)2007-2016 emlix GmbH
 .\"
-.TH e2chroot 5 "Oct 26, 2012" "@VERSION@"
+.TH e2chroot 5 "Dec 22, 2016" "@VERSION@"
 
 .SH NAME
 proj/chroot \- chroot configuration file of an e2factory project
@@ -19,20 +19,21 @@ The file has following structure:
 e2chroot {
   default_groups = { "<string>", ... },
   groups = {
-
     {
-    name = "<string>",
-    server = "<string>",
-    files = {
-            { server = "<string>",
-              location = "<string>",
-              sha1 = "<string>", },
-            ...
-            },
+      name = "<string>",
+      server = "<string>",
+      files = {
+        {
+          server = "<string>",
+          location = "<string>",
+          sha1 = "da39a3ee5e6b4b0d3255bfef95601890afd80709",
+          sha256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+        },
+        ...
+      },
     },
     ...
   }
-
 }
 .fi
 
@@ -71,7 +72,7 @@ Type: Table
 List of files belonging to the chroot group.
 
 .TP
-.BR server 
+.BR server
 (on file level)
 .br
 Type: String
@@ -88,7 +89,13 @@ Path to the file on the server.
 .BR sha1
 Type: String
 .br
-sha1 check-sum of the file.
+SHA-1 checksum of the file.
+
+.TP
+.BR sha256
+Type: String
+.br
+SHA-256 checksum of the file.
 
-.SH COPYRIGHT
-(c)2013 emlix GmbH
+.SH "SEE ALSO"
+.BR e2factory(1)
index d92b3656b2e9d2a16f11db446fd7ac4824f393e6..edbcd887b7635b7471b70c820321b9abfe59b43b 100644 (file)
@@ -1,14 +1,14 @@
 .\" Man page for e2licence
 .\"
-.\" (c)2007, 2012 emlix GmbH
+.\" (c)2007-2016 emlix GmbH
 .\"
-.TH e2licence 5 "Oct 26, 2012" "@VERSION@"
+.TH e2licence 5 "Dec 22, 2016" "@VERSION@"
 
 .SH NAME
 proj/licence \- licence configuration file of an e2factory project
 
 .SH DESCRIPTION
-The mandatory file  \fBproj/licence\fR defines the licences that could be used in
+The mandatory file \fBproj/licence\fR defines the licences that could be used in
 source configurations.
 
 
@@ -20,11 +20,14 @@ e2licence {
   ["<licence>"] = {
     server = "<string>",
     files = {
-            { server = "<string>",
-              location = "<string>",
-              sha1 = "<string>", },
-            ...
-            },
+      {
+        server = "<string>",
+        location = "<string>",
+        sha1 = "da39a3ee5e6b4b0d3255bfef95601890afd80709",
+        sha256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+        ...
+      },
+    },
   },
   ...
 }
@@ -33,7 +36,7 @@ e2licence {
 .SH KEYS
 
 .TP
-.BR <licence>
+.BR licence
 Type: String
 .br
 Name of the licence.
@@ -53,7 +56,7 @@ Type: Table
 List of files belonging to the licence.
 
 .TP
-.BR server 
+.BR server
 (on file level)
 .br
 Type: String
@@ -70,10 +73,13 @@ Path to the licence file on server.
 .BR sha1
 Type: String
 .br
-SHA-1 check-sum of the file.
+SHA-1 checksum of the file.
+
+.TP
+.BR sha256
+Type: String
+.br
+SHA-256 checksum of the file.
 
 .SH "SEE ALSO"
 .BR e2factory(1)
-
-.SH COPYRIGHT
-(c)2013 emlix GmbH
index 05709131f80e18ab721189aa5b65c17640d4e8f5..6c578301ee06cb4d4d4f21da53e76ca6a7b13e17 100644 (file)
@@ -1,17 +1,16 @@
 .\" Man page for e2source
 .\"
-.\" (c)2007, 2012 emlix GmbH
+.\" (c)2007-2016 emlix GmbH
 .\"
-.TH e2source 5 "Oct 29, 2012" "@VERSION@"
+.TH e2source 5 "Dec 22, 2016" "@VERSION@"
 
 .SH NAME
 src/*/config \- source configuration files of an e2factory project
 
 .SH DESCRIPTION
-The mandatory files \fBsrc/<dir>/config\fR configure sources to be used when building results. The name of
-the directory \fB<dir>\fR defines the source-name. 
-In case of sub-directories, all directories below \fBsrc/\fR do form the
-source-name separated by dots.
+The mandatory files \fBsrc/<dir>/config\fR configure sources to be used when building results.
+The name of the directory \fB<dir>\fR defines the source-name.
+In case of sub-directories, all directories below \fBsrc/\fR do form the source-name separated by dots.
 .br
 e.g.:
 \fBsrc/<name1>/<name2>/config\fR leads to source name: \fB<name1>.<name2>\fR.
@@ -34,15 +33,18 @@ e2source {
   type = "file",
   server = "<string>",
   file = {
-        { licences = {"<string>", ...},
-          server = "<string>",
-          location = "<string>",
-          sha1 = "<string>",
-          copy = "<string>",
-          patch = "<string>",
-          unpack = "<string>", },
-        ...
-        },
+    {
+      licences = {"<string>", ...},
+      server = "<string>",
+      location = "<string>",
+      sha1 = "da39a3ee5e6b4b0d3255bfef95601890afd80709",
+      sha256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+      copy = "<string>",
+      patch = "<string>",
+      unpack = "<string>",
+    },
+    ...
+  },
 }
 .fi
 
@@ -93,7 +95,7 @@ Name of the licence(s) that apply to this specific file, defaults to
 licences on source level, if omitted.
 
 .TP
-.BR server 
+.BR server
 (on file level)
 .br
 Type: String
@@ -110,7 +112,13 @@ Path of the file on server.
 .BR sha1
 Type: String
 .br
-SHA-1 check-sum of the file.
+SHA-1 checksum of the file.
+
+.TP
+.BR sha256
+Type: String
+.br
+SHA-256 checksum of the file.
 
 .TP
 .BR copy
@@ -136,7 +144,7 @@ argument. Mutual exclusive to \fBcopy\fR and \fBunpack\fR.
 .BR unpack
 Type: String
 .br
-The file is an archive (tarball) it is unpacked and a link pointing to the directory 
+The file is an archive (tarball) it is unpacked and a link pointing to the directory
 defined in string is created. Name of the link equals  source-name. Mutual exclusive
 to \fBcopy\fR and \fBpatch\fR.
 
@@ -298,6 +306,3 @@ Path to the directory to be used in working copy mode.
 
 .SH "SEE ALSO"
 .BR e2factory(1)
-
-.SH COPYRIGHT
-(c)2013 emlix GmbH