Skip to content

Commit 28cee5f

Browse files
Add missing API doc
Signed-off-by: Konrad Weihmann <[email protected]>
1 parent fd58403 commit 28cee5f

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

docs/api-documentation.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@
9191
* [get\_protected\_append\_vars](#oelint_parser.const_vars.get_protected_append_vars)
9292
* [get\_known\_vars](#oelint_parser.const_vars.get_known_vars)
9393
* [get\_known\_machines](#oelint_parser.const_vars.get_known_machines)
94+
* [get\_image\_classes](#oelint_parser.const_vars.get_image_classes)
95+
* [get\_image\_variables](#oelint_parser.const_vars.get_image_variables)
9496
* [get\_base\_varset](#oelint_parser.const_vars.get_base_varset)
9597
* [oelint\_parser.inlinerep](#oelint_parser.inlinerep)
9698
* [oelint\_parser.cls\_stash](#oelint_parser.cls_stash)
@@ -114,6 +116,8 @@
114116
* [expand\_term](#oelint_parser.helper_files.expand_term)
115117
* [get\_valid\_package\_names](#oelint_parser.helper_files.get_valid_package_names)
116118
* [get\_valid\_named\_resources](#oelint_parser.helper_files.get_valid_named_resources)
119+
* [is\_image](#oelint_parser.helper_files.is_image)
120+
* [is\_packagegroup](#oelint_parser.helper_files.is_packagegroup)
117121
* [oelint\_parser.const\_func](#oelint_parser.const_func)
118122
* [oelint\_parser.parser](#oelint_parser.parser)
119123
* [get\_full\_scope](#oelint_parser.parser.get_full_scope)
@@ -1350,6 +1354,32 @@ get known machines
13501354

13511355
- `list` - list of known machine names
13521356

1357+
<a name="oelint_parser.const_vars.get_image_classes"></a>
1358+
#### get\_image\_classes
1359+
1360+
```python
1361+
get_image_classes()
1362+
```
1363+
1364+
get known classes used exclusively in an image
1365+
1366+
**Returns**:
1367+
1368+
- `list` - list of known class names
1369+
1370+
<a name="oelint_parser.const_vars.get_image_variables"></a>
1371+
#### get\_image\_variables
1372+
1373+
```python
1374+
get_image_variables()
1375+
```
1376+
1377+
get known variables used exclusively in an image
1378+
1379+
**Returns**:
1380+
1381+
- `list` - list of known variable names
1382+
13531383
<a name="oelint_parser.const_vars.get_base_varset"></a>
13541384
#### get\_base\_varset
13551385

@@ -1705,6 +1735,44 @@ Get list of valid SRCREV resource names
17051735

17061736
- `list` - list of valid SRCREV resource names
17071737

1738+
<a name="oelint_parser.helper_files.is_image"></a>
1739+
#### is\_image
1740+
1741+
```python
1742+
is_image(stash, _file)
1743+
```
1744+
1745+
returns if the file is likely an image recipe or not
1746+
1747+
**Arguments**:
1748+
1749+
- `stash` _oelint_parser.cls_stash.Stash_ - current stash
1750+
- `_file` _str_ - Full path to file
1751+
1752+
1753+
**Returns**:
1754+
1755+
- `bool` - True if _file is an image recipe
1756+
1757+
<a name="oelint_parser.helper_files.is_packagegroup"></a>
1758+
#### is\_packagegroup
1759+
1760+
```python
1761+
is_packagegroup(stash, _file)
1762+
```
1763+
1764+
returns if the file is likely a packagegroup recipe or not
1765+
1766+
**Arguments**:
1767+
1768+
- `stash` _oelint_parser.cls_stash.Stash_ - current stash
1769+
- `_file` _str_ - Full path to file
1770+
1771+
1772+
**Returns**:
1773+
1774+
- `bool` - True if _file is a packagegroup recipe
1775+
17081776
<a name="oelint_parser.const_func"></a>
17091777
# oelint\_parser.const\_func
17101778

0 commit comments

Comments
 (0)