dev-manual: Updates to "Avoiding Duplicating Include Files" section.

I removed the last paragraph example as it is not a good example.
Unfortunately, there is not a good example so I replaced it with
a minor suggestive work-around at the end of the first paragraph.

Also, used some <replaceable></replaceable> formatting for the
first paragraph.

(From yocto-docs rev: 6c3989fd4fe41a6434d70208d59747060e62a366)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2015-02-09 08:48:06 -08:00 committed by Richard Purdie
parent ef959e61c4
commit f3410bfc75
1 changed files with 8 additions and 20 deletions

View File

@ -273,29 +273,17 @@
the included file, use the path relative to the original
layer directory to refer to the file.
For example, use
<filename>require recipes-core/somepackage/somefile.inc</filename>
instead of <filename>require somefile.inc</filename>.
<filename>require recipes-core/</filename><replaceable>package</replaceable><filename>/</filename><replaceable>file</replaceable><filename>.inc</filename>
instead of <filename>require </filename><replaceable>file</replaceable><filename>.inc</filename>.
If you're finding you have to overlay the include file,
it could indicate a deficiency in the include file in
the layer to which it originally belongs.
If this is the case, you need to address that deficiency
instead of overlaying the include file.
</para>
<para>
For example, consider how support plug-ins for the Qt 4
database are configured.
The Source Directory does not have MySQL or PostgreSQL.
However, OpenEmbedded's layer <filename>meta-oe</filename>
does.
Consequently, <filename>meta-oe</filename> uses
append files to modify the
<filename>QT_SQL_DRIVER_FLAGS</filename> variable to
enable the appropriate plug-ins.
This variable was added to the <filename>qt4.inc</filename>
include file in the Source Directory specifically to allow
the <filename>meta-oe</filename> layer to be able to control
which plug-ins are built.
If this is the case, you should try to address that
deficiency instead of overlaying the include file.
For example, you could address this by getting the
maintainer of the include file to add a variable or
variables to make it easy to override the parts needing
overwritten.
</para>
</section>