Bug 11481 - Docs: Is external.desc required?
Summary: Docs: Is external.desc required?
Status: RESOLVED FIXED
Alias: None
Product: buildroot
Classification: Unclassified
Component: Other (show other bugs)
Version: 2018.08.2
Hardware: All Linux
: P5 normal
Target Milestone: ---
Assignee: Yann E. MORIN
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-11-02 11:26 UTC by Philipp Wagner
Modified: 2018-11-02 20:31 UTC (History)
2 users (show)

See Also:
Host:
Target:
Build:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Philipp Wagner 2018-11-02 11:26:30 UTC 
I have a minor docs comment.

https://buildroot.org/downloads/manual/manual.html#customize

In the user guide, section "9.1. Recommended directory structure" the directory tree shows two files for a br2 external tree: 

=====
+-- Config.in (if using a br2-external tree)
+-- external.mk (if using a br2-external tree)
=====

The documentation further down suggests that three files are needed:

=====
9.2.1. Layout of a br2-external tree

A br2-external tree must contain at least those three files, described in the following chapters:

    external.desc
    external.mk
    Config.in 
=====


Most likely the external.desc file is missing from the top section?
Comment 1 Yann E. MORIN 2018-11-02 11:51:21 UTC 
Philipp, All,

Indeed, external.desc is missiing from section 9.1.

Can you send a patch to fix that, to the list, please?

Regards,
Yann E. MORIN.