Add initial documentation, including contributing guidelines#13
Add initial documentation, including contributing guidelines#13ricardosalveti merged 2 commits intoqualcomm-linux:mainfrom
Conversation
Add link to the main README.md file, which is the entrypoint for our documentation. Signed-off-by: Ricardo Salveti <ricardo.salveti@oss.qualcomm.com>
ricardosalveti
force-pushed
the
docs
branch
8 times, most recently
from
21cfe09 to
62d65de
Compare
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.
|
|
||
| ### 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?)
There was a problem hiding this comment.
It is more about the version series, we do say >= 1.4 because they ended up updating the LTS baseline, but we don't expect this to happen in newer releases.
But we do want to support new machines in the 'latest LTS' series.
docs/contributing.md
Outdated
| - 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
There was a problem hiding this comment.
Right, we do test core-image-base actually (will update), but modules are not included by default there, which is ok as we also have the base module list available in the bsp layer.
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!
Not yet complete due missing arduino references, to be added once we include support for uno-q. Co-authored-by: Daiane Angolini <angolini@gmail.com> Signed-off-by: Ricardo Salveti <ricardo.salveti@oss.qualcomm.com>
|
Thanks for the reviews everyone! |
4 participants
No description provided.