local.conf.sample.extended: update the sample for archiver.bbclass

Update archiver.bbclass' sample, make it easier to understand.

[YOCTO #2619]

(From meta-yocto rev: 7a4b496ed5247398b04dc2b81d2f691e3aadd573)

Signed-off-by: Robert Yang <liezhi.yang@windriver.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 27 insertions, 23 deletions

diff --git a/meta-yocto/conf/local.conf.sample.extended b/meta-yocto/conf/local.conf.sample.extended
index 36f1294dea..de4691194a 100644
--- a/meta-yocto/conf/local.conf.sample.extended
+++ b/meta-yocto/conf/local.conf.sample.extended
@@ -182,32 +182,36 @@
 # when the disk space reduces 50M (or the amount of inode reduces 5k).
 #BB_DISKMON_WARNINTERVAL = "50M,5K"
 
-# Archiving source code configuration
-#
-# The following variables control which files to archive and the type to archive to generate.
-# There are three basic class defintions of common operations that might be desired and these
-# can be enabled by uncommenting one of the following lines:
-#
-# INHERIT += "archive-original-source"
-# INHERIT += "archive-patched-source"
-#INHERIT =+ "archive-configured-source"
-#
-# Type of archive:
-# SOURCE_ARCHIVE_PACKAGE_TYPE = 'srpm'
-#SOURCE_ARCHIVE_PACKAGE_TYPE ?= 'tar'
-#
-# Whether to include WORKDIR/temp, .bb and .inc files:
-# 'logs_with_scripts' include WORKDIR/temp directory and .bb and .inc files
-# 'logs' only include WORKDIR/temp
-# ARCHIVER_MODE[log_type] = "logs logs_with_scripts"
-# There are three basic class defintions of common operations 
-# that might be desired and these can be enabled by 
-# uncommenting five of the following lines:
-# ARCHIVER_MODE[filter] ?= "yes no"
-# Filter packages according to license
+# Archiving source code, configure what kind of sources will be archived
+# and the output format. The output files will be put in
+# ${DEPLOY_DIR}/sources/.
+#
+# You can add the following 3 lines to the conf file to get a quick
+# usage:
+#ARCHIVER_MODE ?= "original"
+#ARCHIVER_CLASS = "${@'archive-${ARCHIVER_MODE}-source' if ARCHIVER_MODE != 'none' else ''}"
+#INHERIT += "${ARCHIVER_CLASS}"
+#
+# Detailed configuration:
+# What kind of sources will be archived, the ARCHIVER_MODE could be:
+# original: the ${S} after do_unpack
+# patched : the ${S} after do_patch
+# configured: the ${S} after do_configure
 #ARCHIVER_MODE ?= "original"
+#
+# The output format type, tar or srpm, the default is "tar".
 #ARCHIVER_MODE[type] ?= "tar"
+#
+# Whether include the log file under ${T} and the recipe (.bb and .inc),
+# the default is "logs_with_scripts".
 #ARCHIVER_MODE[log_type] ?= "logs_with_scripts"
+#
+# license filter:
+# yes: Only the COPYLEFT_LICENSE_INCLUDE recipe will be archived
+# no: All kinds lof license will be archived
+# The default is "no"
 #ARCHIVER_MODE[filter] ?= "no"
+#
+# Put the following two lines in the conf file with intact.
 #ARCHIVER_CLASS = "${@'archive-${ARCHIVER_MODE}-source' if ARCHIVER_MODE != 'none' else ''}"
 #INHERIT += "${ARCHIVER_CLASS}"