Bug 1888

What is the suggested documentation fix here?

Add the lines:

SRC_URI[md5sum] = "f148f0a515ffa264ca5723df48cb7011"
SRC_URI[sha256sum] =
"201818aa0540ecc7bec840fb993058eae5927a89a55ebbf57780c795ff200753"

to the example.

Doh, I thought I had addressed this. Thanks RP.

I need to verify if this is the example you want the lines added to.  The bug does not specify the manual.  If this is the example, where do I put the lines Richard suggests?

----------------------

In the following example, mtd-utils is a makefile-based package:

     DESCRIPTION = "Tools for managing memory technology devices."
     SECTION = "base"
     DEPENDS = "zlib lzo e2fsprogs util-linux"
     HOMEPAGE = "http://www.linux-mtd.infradead.org/"
     LICENSE = "GPLv2"
     LIC_FILES_CHKSUM = "file://COPYING;md5=0636e73ff0215e8d672dc4c32c317bb3 \
                         file://include/common.h;beginline=1;endline=17;md5=ba05b07912a44ea2bf81ce409380049c"

     SRC_URI = "git://git.infradead.org/mtd-utils.git;protocol=git;tag=v${PV}"

     S = "${WORKDIR}/git/"

     EXTRA_OEMAKE = "'CC=${CC}' 'CFLAGS=${CFLAGS} -I${S}/include -DWITHOUT_XATTR' \
                     'BUILDDIR=${S}'"

     do_install () {
             oe_runmake install DESTDIR=${D} SBINDIR=${sbindir} MANDIR=${mandir} \
                                INCLUDEDIR=${includedir}
             install -d ${D}${includedir}/mtd/
             for f in ${S}/include/mtd/*.h; do
                     install -m 0644 $f ${D}${includedir}/mtd/
             done
     }

Darren, looking at this I don't understand it. Can you provide a link to the document which needs fixing? I can't find anything requesting phub_util_mac.tar.bz2 be downloaded...

This was just an example. I followed those instructions to add a new recipe for the phub_util_mac tool (it doesn't exist in our repositories). The instructions do not mention the required SRC_URI checksum lines.

The docs, it turns out, are using a git SRC_URI, which I believe requires a SRCREV="..." line. While tarball SRC_URIs require a SRC_URI[md5sum]="".

This is what I'd recommend:

To the existing example recipe, update it to match the one in the current sources:

replace:
SRC_URI = "git://git.infradead.org/mtd-utils.git;protocol=git;tag=v${PV}"

with:
SRC_URI = "git://git.infradead.org/mtd-utils.git;protocol=git;tag=995cfe51b0a3cf32f381c140bf72b21bf91cef1b"

You can see the entire file here:
http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/recipes-devtools/mtd/mtd-utils_1.4.9.bb

Using a named tag breaks working offline, so we shouldn't do that in example documentation. Apparently a SRCREV is not required here.

In the text describing the recipe, consider adding something like this:

"""
If your sources are available as a tarball instead of a git repository, you will need to provide the URL to the tarball as well as an md5 or sha256 sum of the download. For example:

SRC_URI="ftp://ftp.infradead.org/pub/mtd-utils/mtd-utils-1.4.9.tar.bz2"
SRC_URI[md5sum]="82b8e714b90674896570968f70ca778b"

You can generate the md5 or sha1 sums by using the md5sum or sha256sum commands with the target file as the only argument. For example:

$ md5sum mtd-utils-1.4.9.tar.bz2 
82b8e714b90674896570968f70ca778b  mtd-utils-1.4.9.tar.bz2
"""

Richard, do you agree with all the above?

Yes, sounds reasonable to me.

Implemented Darren's suggestions.  There might need to be some tweaking depending on his review.  New section can be found at http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#usingpoky-extend-addpkg-makefile

Scott