packages/custom-package/

[giscus[bot]]

packages/custom-package/

This article summarizes creating a custom package and covers important topics such as the package makefile, package source structure, package directories, and examples of custom packages.

https://documentation.onioniot.com/packages/custom-package/

[crispyoz]

I think there are quite some gaps in this.

1. While it describes the content of the make file, it doesn't explain where to place the file.
2. After adding a new package make file under feeds/, the package is not automatically added to the list_packages. index_packages would be the logical. It is also not available to build.
3. Failed builds always suggest adding -j1 V=s to the the make command line. Perhaps adding an explanation of how to add that would be useful.
4. Simply adding the repository line to the profile doesn't cause the package to be available to build

[greenbreakfast]

@crispyoz thanks for the pointers, this is really helpful! It's easy to overlook steps when you've been working with something for a long time.

I have comments and questions about each point. Let me know what you think:

1. Would adding a section that describes the feed directory (along with a diagram of how the directory looks) to this article clear this up?
2. So it would be helpful to specifically call out the feeds update script? Would adding this to the Compile a Package article and linking this resolve this?
3. Agreed, I think this is best suited as a new section in the Compile a Package article. What do you think?
4. Related to point 2, should we specifically call out the feeds update script?

[crispyoz]

@greenbreakfast thanks for your response. I'm not trying to nitpick, I just came at this with a blank mind since I don't use the wrapper for my custom builds yet, I continue with old build system. I tried to follow step by step and see if there was anything a newbie like myself might trip over.

1. A section on setting up a feed would be useful. My sense is that new players just want to see their feed work, so a local feed is a simple way of making this happen, then reference(s) to the Openwrt docs on how to set up the different types of feeds. I mean the concept of any OpenWrt Makefile and it's "relationship" to the actual Makefile for a source feed is no intuitive.

2. Update feeds is a build system tools, not available in imagebuilder-wrapper, so you need to highlight it is in the openwrt-sdk-wrapper/sdk-wrapper. So it's probably best located in the compile a package article.

3 and 4 are covered in 2 above.

I think it may be useful to highlight that there are 2 separate tools. The imagebuilder wrapper and the sdk wrapper. While the sections do refer to the tools, as a new player it can be a bit of a fog so perhaps a brief paragraph to highlight the existence of separate tools and their purpose.

Overall I think the documentation is excellent and is one of the great benefits of the Onion echo system, these are just some minor tweaks I think would be useful.

[greenbreakfast]

@crispyoz not a nitpick at all! There are a few different concepts and a few different tools being used - each with slightly different setups based on what you're trying to do. It can get very confusing and a little hard to navigate. I appreciate the feedback!

I've added issues #191 and #192 to try to outline the changes to the articles to address your points. Please take a look and let me know if that would help or if I've missed anything!

[greenbreakfast]

Hey @crispyoz, we've updated this article and the compile a package article based on your feedback. Take a look and let me know if it addresses the gaps you mentioned. We're always open to suggestions on how to make this documentation the best that it can be!