docs.ubports.com icon indicating copy to clipboard operation
docs.ubports.com copied to clipboard

docs: Add generic standalone kernel porting method

Open muhammad23012009 opened this issue 1 year ago • 12 comments

muhammad23012009 avatar Mar 12 '23 15:03 muhammad23012009

Hey. Thanks for starting on H10. I haven't read everything in detail but allow me to share one thought quickly right away: Is all of this really specific for 10? It doesn't seem like to me. I got the impression there is a lot of added info. E.g., how to go look for a device tree, but this applies to every android version. Other parts I'm wondering whether this will be a lot of duplication between 9 and 10. It would be better to have common parts in a common section and only highlight version specific parts per Android version.

Let me know what you think

doniks avatar Mar 12 '23 20:03 doniks

Hi! Thanks for your reply. I thought about the device-tree bit, but that was only for if somebody needed to find it on the spot. It could be added to a common document nonetheless. Everything else was written from scratch and not copied from anywhere, and the deviceinfo parts are important since halium-9.0 doesn't support most of them I believe.

muhammad23012009 avatar Mar 13 '23 07:03 muhammad23012009

I thought about the device-tree bit, but that was only for if somebody needed to find it on the spot. It could be added to a common document nonetheless.

I think it is very helpful! Wrt common doc, I'd say

  • "Getting device kernel source code" could be added at the end of Introduction section. Along with "Finding your correct defconfig"
  • "Making a device source for build" could go as a new section before halium9/10 standalone method
  • in general please check the formatting of your PR https://ci.ubports.com/job/docs.ubports.com/job/PR-558/1/artifact/_build/html/porting/build_and_boot/H10_gitlab_build.html . especially indentation/quotation and code formatting

doniks avatar Mar 13 '23 08:03 doniks

I think it should be just called a Ubuntu Touch porting method for Treble devices (Android 9-11, soon 12) without reference to specific Halium version in the title, as it will confuse people. Currently it applies to Halium from 9 to 11.

NotKit avatar Mar 21 '23 08:03 NotKit

ping

doniks avatar Jul 23 '23 15:07 doniks

I'm conflicted with this PR. there was no followup for a year, but a) it seems to me there are generic (not just H10) additions in here and b) documenting newer halium versions would be very useful, however the review is still open

But in case anyone sees this here. Do not hesitate to make your own alternative pr to update Halium docs, just because this PR is open. It seems very much dormant.

doniks avatar Mar 24 '24 13:03 doniks

I'm conflicted with this PR. there was no followup for a year, but a) it seems to me there are generic (not just H10) additions in here and b) documenting newer halium versions would be very useful, however the review is still open

But in case anyone sees this here. Do not hesitate to make your own alternative pr to update Halium docs, just because this PR is open. It seems very much dormant.

It isn't all that dormant. I've been working on new additions for this PR, making everything generic and adding much more information about the current porting method. I just need a bit of time to complete it, hopefully should be done by the first week of April :)

muhammad23012009 avatar Mar 25 '24 05:03 muhammad23012009

Awesome!

doniks avatar Mar 25 '24 06:03 doniks

Awesome!

I have updated the docs and pushed again.

muhammad23012009 avatar Apr 06 '24 16:04 muhammad23012009

For @doniks: we discussed with @muhammad23012009 that Halium 9 section should be completely dropped/replaced due to being no longer relevant in overall.

NotKit avatar Apr 06 '24 16:04 NotKit

Thanks for sticking with it @muhammad23012009 . Did you see that it fails to build: https://ci.ubports.com/blue/organizations/jenkins/docs.ubports.com/detail/PR-558/21/pipeline I think you need a redirect https://docs.ubports.com/en/latest/contribute/documentation.html#moving-pages

doniks avatar Apr 06 '24 19:04 doniks

Thanks for sticking with it @muhammad23012009 . Did you see that it fails to build: https://ci.ubports.com/blue/organizations/jenkins/docs.ubports.com/detail/PR-558/21/pipeline I think you need a redirect https://docs.ubports.com/en/latest/contribute/documentation.html#moving-pages

Done.

muhammad23012009 avatar Apr 07 '24 09:04 muhammad23012009