Add initial documentation, including contributing guidelines #13
Conversation
Add link to the main README.md file, which is the entrypoint for our documentation. Signed-off-by: Ricardo Salveti <[email protected]>
ricardosalveti
force-pushed
the
docs
branch
7 times, most recently
from
fd715f6 to
21cfe09
Compare
Not yet complete due missing arduino references, to be added once we include support for uno-q. Signed-off-by: Ricardo Salveti <[email protected]>
angolini
left a comment
angolini
left a comment
There was a problem hiding this comment.
Great doc!
I add a comment regarding mentioning the Qualcomm Linux version, but it looks like it's inevitable to explicitly add the version, so maybe it can be ignored.
| Because this layer expects to host multiple vendor platforms: | ||
| - Use **machine overrides** (`:machine` or `:append:machine`) to confine board-specific logic. | ||
| - Avoid cross-contamination between machines or with upstream `meta-qcom`. | ||
| - Do not introduce SoC-generic behavior under a machine-specific path. |
There was a problem hiding this comment.
I think we can add in this line something regarding upstreaming to meta-qcom, a suggestion would be:
| - Do not introduce SoC-generic behavior under a machine-specific path. | |
| - Do not introduce SoC-generic behavior under a machine-specific path. Those SoC-generic behavior must be sent/upstreamed to `meta-qcom` instead. |
| - [`poky-altcfg`](https://git.yoctoproject.org/poky/tree/meta-poky/conf/distro/poky-altcfg.conf) (systemd-compatible) | ||
| - [`meta-qcom-distro`](https://github.com/qualcomm-linux/meta-qcom-distro) |
There was a problem hiding this comment.
do we really prefer poky testing first? (I would invert the lines to make meta-qcom-distro appear as first suggestion, but it depends on what is tested by default
| - Each contributor acts as the **maintainer** of their changes, upstream and downstream. | ||
| - Vendors must appoint a **point-of-contact (PoC)** to review and triage vendor-specific PRs and issues promptly. |
There was a problem hiding this comment.
What does it mean exactly? The PoC's vendor is the person to merge the PR at the end? Is there a mantainers.md file with the list of people acting as maintainer and the person submitting the PR must include that person as reviewer?
I think elaboration is needed in this description
|
|
||
| ## 3 Upstream Baseline | ||
|
|
||
| **Goal:** upstream-aligned BSP enablement serving as the base for future Qualcomm Linux 2.0 releases. |
There was a problem hiding this comment.
Can we avoid using "2.0" here? It will be difficult to remember to update this file when 2.0 becomes something else
|
|
||
| ### 4.1 Expected Contribution Types | ||
|
|
||
| - Machine configuration files |
There was a problem hiding this comment.
Does it mean new machines are accepted in the "latest LTS based" branch, and it must only be supported by 1.4 or latter qualcomm linux version, in other words, in the latest LTS we can have new machines being included supporting not the latest qualcomm linux? (it it's higher or equal than 1.4, even thought the latest today is 1.6?)
| - Firmware recipes referencing vendor-hosted binaries | ||
| - Partition configuration defined through `qcom-ptool` | ||
| - Kernel support via `linux-qcom-next` `.bbappend` | ||
| - CI job validating `core-image-minimal` build and boot on target |
There was a problem hiding this comment.
I understand core-image-minimal does not include non-vital firmware, which can be binaries hosted on an vendor mirror. It means (I believe) that building only core-image-minimal will not detect missing closed firmware files. If this is the intended, so ok
kprosise
left a comment
kprosise
left a comment
There was a problem hiding this comment.
No grammar/style issues that pop out, and Markdown appears to be properly formatted. Approved!
|
|
||
| ```bash | ||
| git clone https://github.com/qualcomm-linux/meta-qcom-3rdparty.git | ||
| bitbake-layers add-layer ../meta-qcom-3rdparty |
There was a problem hiding this comment.
If the user will use the kas maybe he doesn't need to take that step
4 participants
No description provided.