Hi Pavel,
> Currently there's README and HACKING... each describing part of what
> needs to be done to build ofono.
>
> Provide some cross-links and fix build example.
>
> diff --git a/HACKING b/HACKING
> index 15ea291..b1bd599 100644
> --- a/HACKING
> +++ b/HACKING
> @@ -45,7 +45,8 @@ bootstrap-configure since it could export development
> specific settings.
> So the normal steps to checkout, build and install such a repository is
> like this:
>
> - Checkout repository
> + Checkout repositories
> + # git clone git://git.kernel.org/pub/scm/libs/ell/ell.git
> # git clone git://git.kernel.org/pub/scm/network/ofono/ofono.git
> # cd ofono
>
so coming to think about it, I would actually make this a pre-step.
Checkout Embedded Linux Library
# git clone ..
Also this documentation is primarily for maintainers and the few that deal with
making the tarballs. Which is pretty much just me.
> diff --git a/README b/README
> index 45bb2e9..04a50a5 100644
> --- a/README
> +++ b/README
> @@ -16,11 +16,14 @@ To configure run:
> ./configure --prefix=/usr --mandir=/usr/share/man \
> --sysconfdir=/etc --localstatedir=/var
>
> -Configure automatically searches for all required components and packages.
> +Configure automatically searches for all required components and
> +packages, except ell, mentioned below.
>
Nope. Since ELL is actually optional. It is clearly described just a few lines
below.
> To compile and install run:
> make && make install
>
> +See "HACKING" file for details and step-by-step examples.
> +
And that is wrong as well. HACKING is for the developers and people just
installing oFono should not look at that. In addition HACKING is not included
in the tarballs (while README is) and so you not reference a file from README
that is not in the tarballs.
Regards
Marcel
_______________________________________________
ofono mailing list
[email protected]
https://lists.ofono.org/mailman/listinfo/ofono
