[SeaBIOS] [PATCH 1/2] docs: Document 'make EXTRAVERSION=xyz'

[Kevin O'Connor]

On Fri, Oct 23, 2015 at 07:56:06AM +0200, Gerd Hoffmann wrote:
> On Do, 2015-10-22 at 12:20 -0400, Kevin O'Connor wrote:
> > +Distribution builds
> > +===================
> > +
> > +If one is building a binary version of SeaBIOS as part of a package
> > +(such as an rpm) or for wide distribution, please provide the
> > +EXTRAVERSION field during the build. For example:
> > +
> > +`make EXTRAVERSION="-${RPM_PACKAGE_RELEASE}"`
> 
> That'll work, but 'make EXTRAVERSION="-%{release}"' is the shorter and
> more common way to say this.

In the context of an example, however, the ${RPM_PACKAGE_RELEASE}
seems a little more descriptive.  That is, someone not an expert at
RPM should get the gist of it, and an expert at RPM should know enough
to use the preferred syntax anyway.  I'll change it if you think it
should be different though.

BTW, does %release/$RPM_PACKAGE_RELEASE provide the full "-1.fc22"
suffix?  That's what I'd like to see in the extra version.

Also, it occurred to me that we should also document tarball.sh - I'm
thinking adding something like:


If one is building a binary in a build environment that does not have
access to the git tool or does not have the full SeaBIOS git repo
available, then please use an official SeaBIOS tar file as source. If
building from a snapshot (where there is no official SeaBIOS tar) then
one should generate a snapshot tar file on a machine that does support
git using the scripts/tarball.sh tool. For example:

`scripts/tarball.sh`

The tarball.sh script encodes version information in the resulting tar
file which the build can extract and include in the final binary. The
above EXTRAVERSION field should still be set when building from a tar.


-Kevin