Skip to content

Commit

Permalink
docs: fix markdown for includenotfound and requirenotfound
Browse files Browse the repository at this point in the history
  • Loading branch information
lbarthelemy authored and priv-kweihmann committed May 29, 2024
1 parent 7d36f28 commit 0c463d6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/wiki/oelint.file.includenotfound.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ include a/file/from/another/layer.inc

## Why is this bad?

If the an include file doesn't reside in the same layer, it creates an external dependency on something
If an include file doesn't reside in the same layer, it creates an external dependency on something
that is likely beyond the control of the layer.
It will create breakage if the other layer changes the name and/or the path of the include file.

Expand All @@ -28,7 +28,7 @@ Or the include simply doesn't exit at all.
Fix the include path or

```
# noelint: oelint.file.includenotfound
# nooelint: oelint.file.includenotfound
include a/file/from/another/layer.inc
```

Expand Down
14 changes: 7 additions & 7 deletions docs/wiki/oelint.file.requirenotfound.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# oelint.file.includenotfound
# oelint.file.requirenotfound

severity: warning

Expand All @@ -17,19 +17,19 @@ require a/file/from/another/layer.inc

## Why is this bad?

If the an include file doesn't reside in the same layer, it creates an external dependency on something
If a required file doesn't reside in the same layer, it creates an external dependency on something
that is likely beyond the control of the layer.
It will create breakage if the other layer changes the name and/or the path of the include file.
It will create breakage if the other layer changes the name and/or the path of the required file.

Or the include simply doesn't exit at all.
Or the required file simply doesn't exit at all.

## Ways to fix it

Fix the include path or
Fix the required file path or

```
# noelint: oelint.file.includenotfound
# nooelint: oelint.file.requirenotfound
require a/file/from/another/layer.inc
```

in case the include file is from another layer.
in case the required file is from another layer.

0 comments on commit 0c463d6

Please sign in to comment.