Issue 191 completed #198
Merged
Issue 191 completed #198
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
greenbreakfast
suggested changes
Feb 27, 2025
There was a problem hiding this comment.
Hi @remingtontr, looking good. Just a few tweaks needed, see the comments that are part of this review.
Also, in the Compile Packages article, in the "What does it mean for a package to be in production?" section, let's change that sentence to The package source is stored in a remote repository. This remote repository is considered a package feed that the SDK will use as input.
docs/packages/custom-package.md
Outdated
| ### Package Feed Structure | ||
| The following diagram illustrates the structure of a feed directory. | ||
|
|
||
|  |
There was a problem hiding this comment.
Instead of using an image, let's have a code block and just paste in the diagram text.
That should make it more readable for more users (smartphone, desktop, etc)
docs/packages/custom-package.md
Outdated
| ### Working with Package Feeds | ||
| A Package Feed can be considered an input to the OpenWRT SDK or build system. It must be added to the feed configuration and then initialized before packages from the feed can be compiled. | ||
|
|
||
| For information on how to work with Package feeds with Onion’s OpenWRT SDK wrapper, see the article on how to [Compile a Package](compile-package). |
There was a problem hiding this comment.
Please change the link from compile-package to /packages/compile-package
We should use absolute paths in our internal links
|
|
||
| Packages may also include: | ||
|
|
||
| - A files directory to hold configuration and other additional files. |
There was a problem hiding this comment.
Let's bring back all the changes from "file" to "files"
| Packages may also include: | ||
|
|
||
| - A files directory to hold configuration and other additional files. | ||
| - A patches directory is meant to store patches for source code. |
There was a problem hiding this comment.
Let's bring back all the changes from "patch" to "patches"
| 1. Changing which repos are listed in the profile config file. | ||
| 2. Updates to the code in the repo - new versions of code available or fixes to issues causing compilation errors. | ||
| Run the following command to ensure all changes are pulled in before compilation: |
There was a problem hiding this comment.
Let's add a Header 3 here to separate the intro from the actual commands. Maybe something like "Commands to Rerun Compilation" ?
|
Lazar,
I will make these changes and push shortly.
With regard to the changes from File > Files directory and Patch > Patches directory, the correct terms are actually File and Patch, even though there may be multiple files or patches in the directory.
Regards,
Tomas
________________________________
From: Lazar ***@***.***>
Sent: Thursday, February 27, 2025 8:21 AM
To: OnionIoT/documentation ***@***.***>
Cc: Tomas Remington ***@***.***>; Mention ***@***.***>
Subject: Re: [OnionIoT/documentation] Issue 191 completed (PR #198)
@greenbreakfast requested changes on this pull request.
Hi @remingtontr<https://github.com/remingtontr>, looking good. Just a few tweaks needed, see the comments that are part of this review.
Also, in the Compile Packages article, in the "What does it mean for a package to be in production?" section, let's change that sentence to The package source is stored in a remote repository. This remote repository is considered a package feed that the SDK will use as input.
________________________________
In docs/packages/custom-package.md<#198 (comment)>:
@@ -16,14 +16,31 @@ Creating a custom package is valuable for IoT applications, where customizing th
- **Easy Updates:** Custom packages can be easily updated using the Opkg package manager.
+## Package Feeds
+A package feed is a directory or repository that holds the package source files for one or more software packages.
+
+Package source code is the collection of source code and related files forming a software package. Package source files include the Package Makefiles and related source code and files. The package source files serve as input when building a package, with the output being an installable package binary.
+
+Package feeds generally hold a collection of packages that are related or serve a particular use case. Adding a package feed to the feed configuration of the OpenWRT SDK or build system allows users to compile the packages in that feed.
+
+### Package Feed Structure
+The following diagram illustrates the structure of a feed directory.
+
+
Instead of using an image, let's have a code block and just paste in the diagram text.
That should make it more readable for more users (smartphone, desktop, etc)
________________________________
In docs/packages/custom-package.md<#198 (comment)>:
+## Package Feeds
+A package feed is a directory or repository that holds the package source files for one or more software packages.
+
+Package source code is the collection of source code and related files forming a software package. Package source files include the Package Makefiles and related source code and files. The package source files serve as input when building a package, with the output being an installable package binary.
+
+Package feeds generally hold a collection of packages that are related or serve a particular use case. Adding a package feed to the feed configuration of the OpenWRT SDK or build system allows users to compile the packages in that feed.
+
+### Package Feed Structure
+The following diagram illustrates the structure of a feed directory.
+
+
+
+### Working with Package Feeds
+A Package Feed can be considered an input to the OpenWRT SDK or build system. It must be added to the feed configuration and then initialized before packages from the feed can be compiled.
+
+For information on how to work with Package feeds with Onion’s OpenWRT SDK wrapper, see the article on how to [Compile a Package](compile-package).
Please change the link from compile-package to /packages/compile-package
We should use absolute paths in our internal links
________________________________
In docs/packages/custom-package.md<#198 (comment)>:
## The Structure of the Package Source
The package source will always contain a package makefile, which provides information about the package name, version number, dependencies, and the make-up of the package.
Packages may also include:
-- A files directory to hold configuration and other additional files.
Let's bring back all the changes from "file" to "files"
________________________________
In docs/packages/custom-package.md<#198 (comment)>:
## The Structure of the Package Source
The package source will always contain a package makefile, which provides information about the package name, version number, dependencies, and the make-up of the package.
Packages may also include:
-- A files directory to hold configuration and other additional files.
-- A patches directory is meant to store patches for source code.
Let's bring back all the changes from "patch" to "patches"
________________________________
In docs/packages/compile-package.md<#198 (comment)>:
+make: *** [/home/ubuntu/openwrt-sdk-wrapper/openwrt-sdk/include/toplevel.mk:225: package/c-example/compile] Error 2
+make: Leaving directory '/home/ubuntu/openwrt-sdk-wrapper/openwrt-sdk'
+\n>> ERROR: Compile of package c-example returned code 2
+\n>> PACKAGE COMPILATION ERROR!\n
+```
+
+## Rerun Package Compilation
+
+Re-compiling requires a re-run of the feed update step following any code or configuration file modifications, including changes to the listed repositories.
+
+These changes can include:
+
+1. Changing which repos are listed in the profile config file.
+2. Updates to the code in the repo - new versions of code available or fixes to issues causing compilation errors.
+
+Run the following command to ensure all changes are pulled in before compilation:
Let's add a Header 3 here to separate the intro from the actual commands. Maybe something like "Commands to Rerun Compilation" ?
—
Reply to this email directly, view it on GitHub<#198 (review)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A4B4PDMMSU7BW6J2VDUDJZ32R43RFAVCNFSM6AAAAABX524QWSVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDMNBYGI3DMMBZGM>.
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
I agree with this in terms of grammar. However, the directories have to be named |
|
Understood. I have actually renamed them as files and patches.
Tomas
…________________________________
From: Lazar ***@***.***>
Sent: Thursday, February 27, 2025 12:05 PM
To: OnionIoT/documentation ***@***.***>
Cc: Tomas Remington ***@***.***>; Mention ***@***.***>
Subject: Re: [OnionIoT/documentation] Issue 191 completed (PR #198)
With regard to the changes from File > Files directory and Patch > Patches directory, the correct terms are actually File and Patch, even though there may be multiple files or patches in the directory.
I agree with this in terms of grammar. However, the directories have to be named files and patches to work correctly - so I want to avoid any confusion for readers.
—
Reply to this email directly, view it on GitHub<#198 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A4B4PDKAC5PVN4PZA3PMMD32R5V2NAVCNFSM6AAAAABX524QWSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMOBYHE4TSOJRGA>.
You are receiving this because you were mentioned.Message ID: ***@***.***>
[greenbreakfast]greenbreakfast left a comment (OnionIoT/documentation#198)<#198 (comment)>
With regard to the changes from File > Files directory and Patch > Patches directory, the correct terms are actually File and Patch, even though there may be multiple files or patches in the directory.
I agree with this in terms of grammar. However, the directories have to be named files and patches to work correctly - so I want to avoid any confusion for readers.
—
Reply to this email directly, view it on GitHub<#198 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A4B4PDKAC5PVN4PZA3PMMD32R5V2NAVCNFSM6AAAAABX524QWSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMOBYHE4TSOJRGA>.
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates to Create a Custom Package and Compile a Package completed.