Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add comments to Makefile example #110

Closed
nikimanoledaki opened this issue Sep 9, 2022 · 0 comments · Fixed by #156
Closed

Add comments to Makefile example #110

nikimanoledaki opened this issue Sep 9, 2022 · 0 comments · Fixed by #156
Assignees
@yitsushi
Labels
area/documentation Documentation related

Comments

@nikimanoledaki
Copy link
Contributor

The Makefile example is a starting point for someone who is learning about OCM in general and particularly how to use the CLI. As such, it would really help to have comments on each make command with more description of what the command does. This would help with new users and OCM adoption.
@nikimanoledaki nikimanoledaki added the area/documentation Documentation related label Sep 9, 2022
@nikimanoledaki nikimanoledaki changed the title Improve Makefile example Add comments to Makefile example Sep 9, 2022
@yitsushi yitsushi self-assigned this Oct 18, 2022
yitsushi added a commit that referenced this issue Oct 18, 2022
@yitsushi
docs: add comments to the example Makefile
983c28b 
Added comments through a new `help` target because that way anyone can
use `make help` in the `examples/make` directory and get the full list
of targets and a description.

Closes #110

References:
* #110
* https://www.thapaliya.com/en/writings/well-documented-makefiles/
@yitsushi yitsushi mentioned this issue Oct 18, 2022
Merged
yitsushi added a commit that referenced this issue Oct 21, 2022
@yitsushi
docs: add comments to the example Makefile (#156)
e1046af 
* docs: add comments to the example Makefile

Added comments through a new `help` target because that way anyone can
use `make help` in the `examples/make` directory and get the full list
of targets and a description.

Closes #110

References:
* #110
* https://www.thapaliya.com/en/writings/well-documented-makefiles/
hilmarf pushed a commit that referenced this issue Sep 16, 2024
@dependabot
Bump DeterminateSystems/nix-installer-action from 13 to 14 in the ci …
c18ba2e 
…group (#926)

Bumps the ci group with 1 update:
[DeterminateSystems/nix-installer-action](https://github.com/determinatesystems/nix-installer-action).

Updates `DeterminateSystems/nix-installer-action` from 13 to 14
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/determinatesystems/nix-installer-action/releases">DeterminateSystems/nix-installer-action's
releases</a>.</em></p>
<blockquote>
<h2>v14</h2>
<h2>What's Changed</h2>
<ul>
<li>Log in to flakehub for 'fh' too by <a
href="https://github.com/grahamc"><code>@​grahamc</code></a> in <a
href="https://redirect.github.com/DeterminateSystems/nix-installer-action/pull/110">DeterminateSystems/nix-installer-action#110</a></li>
<li>Update <code>detsys-ts</code>: Log in to flakehub for 'fh' too (<a
href="https://redirect.github.com/determinatesystems/nix-installer-action/issues/110">#110</a>)
by <a
href="https://github.com/detsys-pr-bot"><code>@​detsys-pr-bot</code></a>
in <a
href="https://redirect.github.com/DeterminateSystems/nix-installer-action/pull/111">DeterminateSystems/nix-installer-action#111</a></li>
<li>Update <code>detsys-ts</code>: Merge pull request <a
href="https://redirect.github.com/determinatesystems/nix-installer-action/issues/57">#57</a>
from DeterminateSystems/fix-typo by <a
href="https://github.com/detsys-pr-bot"><code>@​detsys-pr-bot</code></a>
in <a
href="https://redirect.github.com/DeterminateSystems/nix-installer-action/pull/112">DeterminateSystems/nix-installer-action#112</a></li>
<li>fixup extra arguments by <a
href="https://github.com/grahamc"><code>@​grahamc</code></a> in <a
href="https://redirect.github.com/DeterminateSystems/nix-installer-action/pull/113">DeterminateSystems/nix-installer-action#113</a></li>
<li>Update <code>detsys-ts</code>: Merge pull request <a
href="https://redirect.github.com/determinatesystems/nix-installer-action/issues/58">#58</a>
from DeterminateSystems/collect-crash-logs by <a
href="https://github.com/detsys-pr-bot"><code>@​detsys-pr-bot</code></a>
in <a
href="https://redirect.github.com/DeterminateSystems/nix-installer-action/pull/116">DeterminateSystems/nix-installer-action#116</a></li>
<li>Update <code>detsys-ts</code>: Merge pull request <a
href="https://redirect.github.com/determinatesystems/nix-installer-action/issues/61">#61</a>
from DeterminateSystems/use-coalesce-for-array by <a
href="https://github.com/detsys-pr-bot"><code>@​detsys-pr-bot</code></a>
in <a
href="https://redirect.github.com/DeterminateSystems/nix-installer-action/pull/117">DeterminateSystems/nix-installer-action#117</a></li>
<li>Update <code>detsys-ts</code>: Merge pull request <a
href="https://redirect.github.com/determinatesystems/nix-installer-action/issues/62">#62</a>
from DeterminateSystems/dont-pull-microstackshots by <a
href="https://github.com/detsys-pr-bot"><code>@​detsys-pr-bot</code></a>
in <a
href="https://redirect.github.com/DeterminateSystems/nix-installer-action/pull/118">DeterminateSystems/nix-installer-action#118</a></li>
<li>Update <code>detsys-ts</code>: Merge pull request <a
href="https://redirect.github.com/determinatesystems/nix-installer-action/issues/63">#63</a>
from DeterminateSystems/retry-streams by <a
href="https://github.com/detsys-pr-bot"><code>@​detsys-pr-bot</code></a>
in <a
href="https://redirect.github.com/DeterminateSystems/nix-installer-action/pull/120">DeterminateSystems/nix-installer-action#120</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/DeterminateSystems/nix-installer-action/compare/v13...v14">https://github.com/DeterminateSystems/nix-installer-action/compare/v13...v14</a></p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/DeterminateSystems/nix-installer-action/commit/da36cb69b1c3247ad7a1f931ebfd954a1105ef14"><code>da36cb6</code></a>
Update <code>detsys-ts</code> for: `Merge pull request <a
href="https://redirect.github.com/determinatesystems/nix-installer-action/issues/63">#63</a>
from DeterminateSystems/retry...</li>
<li><a
href="https://github.com/DeterminateSystems/nix-installer-action/commit/1406b8b52c69ae5b6fd0959324a0522414b4deed"><code>1406b8b</code></a>
Update <code>detsys-ts</code> for: `Merge pull request <a
href="https://redirect.github.com/determinatesystems/nix-installer-action/issues/62">#62</a>
from DeterminateSystems/dont-...</li>
<li><a
href="https://github.com/DeterminateSystems/nix-installer-action/commit/197bf2b2a51d25e8e5dd71f732c99e2b86e58ec2"><code>197bf2b</code></a>
Update <code>detsys-ts</code> for: `Merge pull request <a
href="https://redirect.github.com/determinatesystems/nix-installer-action/issues/61">#61</a>
from DeterminateSystems/use-c...</li>
<li><a
href="https://github.com/DeterminateSystems/nix-installer-action/commit/452d9c7008b6c3c93e759469d210493570a698f2"><code>452d9c7</code></a>
Update <code>detsys-ts</code> for: `Merge pull request <a
href="https://redirect.github.com/determinatesystems/nix-installer-action/issues/58">#58</a>
from DeterminateSystems/colle...</li>
<li><a
href="https://github.com/DeterminateSystems/nix-installer-action/commit/033f039e5c752cb1cbc6ac1dd2e59c4ca58adf00"><code>033f039</code></a>
fixup extra arguments (<a
href="https://redirect.github.com/determinatesystems/nix-installer-action/issues/113">#113</a>)</li>
<li><a
href="https://github.com/DeterminateSystems/nix-installer-action/commit/468e81bb995e3f30f4d668dbecacb25e85321d3f"><code>468e81b</code></a>
Update <code>detsys-ts</code> for: `Merge pull request <a
href="https://redirect.github.com/determinatesystems/nix-installer-action/issues/57">#57</a>
from DeterminateSystems/fix-t...</li>
<li><a
href="https://github.com/DeterminateSystems/nix-installer-action/commit/b164ca324197520b849b91376ed19d9845526805"><code>b164ca3</code></a>
Merge pull request <a
href="https://redirect.github.com/determinatesystems/nix-installer-action/issues/111">#111</a>
from detsys-pr-bot/detsys-ts-update-d353465ae6a557619...</li>
<li><a
href="https://github.com/DeterminateSystems/nix-installer-action/commit/055e848f13e3e986e9702d1c0a942bd4b93a0ae9"><code>055e848</code></a>
Update <code>detsys-ts</code> for: <code>Log in to flakehub for 'fh' too
([#110](https://github.com/determinatesystems/nix-installer-action/issues/110))</code>
(`d353465ae6...</li>
<li><a
href="https://github.com/DeterminateSystems/nix-installer-action/commit/d41fccdd9e8fb268f5976e0b6ab455cd5d60e380"><code>d41fccd</code></a>
Log in to flakehub for 'fh' too (<a
href="https://redirect.github.com/determinatesystems/nix-installer-action/issues/110">#110</a>)</li>
<li>See full diff in <a
href="https://github.com/determinatesystems/nix-installer-action/compare/v13...v14">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=DeterminateSystems/nix-installer-action&package-manager=github_actions&previous-version=13&new-version=14)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore <dependency name> major version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's major version (unless you unignore this specific
dependency's major version or upgrade to it yourself)
- `@dependabot ignore <dependency name> minor version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's minor version (unless you unignore this specific
dependency's minor version or upgrade to it yourself)
- `@dependabot ignore <dependency name>` will close this group update PR
and stop Dependabot creating any more for the specific dependency
(unless you unignore this specific dependency or upgrade to it yourself)
- `@dependabot unignore <dependency name>` will remove all of the ignore
conditions of the specified dependency
- `@dependabot unignore <dependency name> <ignore condition>` will
remove the ignore condition of the specified dependency and ignore
conditions


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yitsushi yitsushi

Labels
area/documentation Documentation related
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: add comments to the example Makefile open-component-model/ocm
2 participants
@yitsushi @nikimanoledaki