public inbox for linux-mtd@lists.infradead.org
 help / color / mirror / Atom feed
From: "Brian Norris" <computersforpeace@gmail.com>
To: "Artem Bityutskiy" <dedekind1@gmail.com>
Cc: brian.foster@maxim-ic.com,
	Brian Norris <computersforpeace@gmail.com>,
	linux-mtd@lists.infradead.org
Subject: [PATCH 6/9] doc: update info on compiling mtd-utils
Date: Mon, 8 Aug 2011 12:37:16 -0700	[thread overview]
Message-ID: <1312832239-21759-7-git-send-email-computersforpeace@gmail.com> (raw)
In-Reply-To: <1312832239-21759-1-git-send-email-computersforpeace@gmail.com>

The recursive build system for mtd-utils was rewritten enough recently
such that the description regarding builing ubi-utils by typing `make'
from its subdirectory is now incorrect. Update the UBI docs to reflect
this.

Also, I copied and edited some basic info from the UBI docs to include
in the general description on compiling mtd-utils.

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
---
 doc/ubi.xml     |   11 ++++++-----
 faq/general.xml |   21 ++++++++++++++++-----
 2 files changed, 22 insertions(+), 10 deletions(-)

diff --git a/doc/ubi.xml b/doc/ubi.xml
index d3f4516..98cb69c 100644
--- a/doc/ubi.xml
+++ b/doc/ubi.xml
@@ -213,15 +213,16 @@ git tree. Please, use this branch unless you are an UBI developer.</p>
 
 <h2><a name="L_usptools">User-space tools</a></h2>
 
-<p>UBI user-space tools are available from the the following git repository:</p>
+<p>UBI user-space tools, as well as other MTD user-space tools, are available
+from the the following git repository:</p>
 
 <code>git://git.infradead.org/mtd-utils.git</code>
 
-<p>Please, clone it and compile. The easiest way to compile UBI tools is to go
-straight to the <code>ubi-utils</code> sub-directory and type
-<code>make</code>. <a href="../faq/general.html#L_compile_mtd">This</a> section
+<p>Please, clone it and compile using <code>make</code> from the root mtd-utils
+directory.  <a href="../faq/general.html#L_compile_mtd">This section</a>
 provides information about how to compile the whole <code>mtd-utils</code>
-repository tree.</p>
+repository tree. You should find the UBI tools under the <code>ubi-utils</code>
+sub-directory.</p>
 
 <p>The repository contains the following UBI tools:</p>
 <ul>
diff --git a/faq/general.xml b/faq/general.xml
index 0336a32..a4e82f3 100644
--- a/faq/general.xml
+++ b/faq/general.xml
@@ -256,11 +256,22 @@ unlock them.
 <H2>How do I compile the mtd-utils tree?</H2>
 </A>
 
-<p>You have to install libraries the tools depend on. Please, find
-the information about <code>mkfs.jffs2</code> dependencies
-<a href="../faq/jffs2.html#L_mkfs_jffs2_comp">here</a> and the
-the information about <code>mkfs.ubifs</code> dependencies
-<a href="../faq/ubifs.html#L_mkfs_ubifs_comp">here</a>.</p>
+<P>
+The MTD and UBI user-space tools are available from the the following git
+repository:
+</P>
+
+<CODE>git://git.infradead.org/mtd-utils.git</CODE>
+
+<P>
+To compile, first you have to install libraries the tools depend on. You can
+find the information about <CODE>mkfs.jffs2</CODE> dependencies
+<A HREF="jffs2.html#L_mkfs_jffs2_comp">here</A> and the the information about
+<CODE>mkfs.ubifs</CODE> dependencies
+<A HREF="ubifs.html#L_mkfs_ubifs_comp">here</A>. Once you have these satisfied,
+you should be able to simply type <CODE>make</CODE> from the root mtd-utils
+directory.
+</P>
 
 
 <INCLUDE file="../inc/footer.tmpl" />
-- 
1.7.0.4

  parent reply	other threads:[~2011-08-08 19:38 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-08-08 19:37 [PATCH 0/9] mtd-www: various fixes, bug reporting info Brian Norris
2011-08-08 19:37 ` [PATCH 1/9] UBIFS FAQ: spelling, grammar Brian Norris
2011-08-08 19:37 ` [PATCH 2/9] faq: general: update "pleonasm" description Brian Norris
2011-08-08 19:37 ` [PATCH 3/9] faq: general: turn statement into a question Brian Norris
2011-08-08 19:37 ` [PATCH 4/9] faq/doc: ubi(fs): move "bug report" questions to FAQ Brian Norris
2011-08-08 19:37 ` [PATCH 5/9] doc: nand: update YAFFS URL Brian Norris
2011-08-08 19:37 ` Brian Norris [this message]
2011-08-08 19:37 ` [PATCH 7/9] faq: ubi(fs): sending bug reports using `mtdinfo' Brian Norris
2011-08-09 22:03   ` [PATCH v2 " Brian Norris
2011-08-08 19:37 ` [PATCH 8/9] faq: ubi(fs): small spelling, URL fixups Brian Norris
2011-08-09 22:05   ` [PATCH v2 " Brian Norris
2011-08-08 19:37 ` [PATCH 9/9] faq: general: add bug reporting FAQ Brian Norris
2011-08-09  8:10   ` Brian Foster
2011-08-09 22:05   ` [PATCH v2 " Brian Norris
2011-08-10  7:54     ` Brian Foster
2011-08-10  8:34       ` [PATCH " Brian Norris
2011-08-08 20:00 ` [PATCH 0/9] mtd-www: various fixes, bug reporting info Artem Bityutskiy
2011-08-15 12:19 ` Artem Bityutskiy

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1312832239-21759-7-git-send-email-computersforpeace@gmail.com \
    --to=computersforpeace@gmail.com \
    --cc=brian.foster@maxim-ic.com \
    --cc=dedekind1@gmail.com \
    --cc=linux-mtd@lists.infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox