scottk/OpenNetworkLinux
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/OpenNetworkLinux.git synced 2025-11-03 03:38:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated doxygen links to local versions in the gh-pages branch.

Browse Source
This commit is contained in:
Jeffrey Townsend
2019-05-29 17:01:12 +00:00
parent 3c6d56fd43
commit a1b3b3ff18
20 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
onlp/applications/attributes.md
View File

@@ -27,5 +27,5 @@ The fields of the ```onlp_asset_info_t``` structure are defined by the ONLP API
This attribute should be implemented at a minimum by the Chassis OID to return important system information (like firmware revisions).
## Attribute Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__attributes.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__attributes.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/attribute.h)

2
onlp/applications/chassis.md
View File

@@ -24,7 +24,7 @@ It is possible to query the Chassis for any generic debug, internal state or sta
## Chassis Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__oid-chassis.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__oid-chassis.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/chassis.h)
---

2
onlp/applications/fan.md
View File

@@ -7,7 +7,7 @@ The current status and capabilities of a fan are queried using ```onlp_fan_info_
Fan features include things like direction, RPM, and speed percentage.
## Fan Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__oid-fan.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__oid-fan.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/fan.h)
---

2
onlp/applications/generic.md
View File

@@ -11,7 +11,7 @@ The current status of a generic oid is queried using ```onlp_generic_info_get```
There are no fields defined in the information structure. Custom interaction with a Generic OID must be done through the OID Attribute APIs.
## Generic Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__oid-generic.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__oid-generic.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/generic.h)
---

2
onlp/applications/led.md
View File

@@ -13,7 +13,7 @@ LED features include things like available colors, blinking modes, and character
You can change the current mode of the LED if supported.
## LED Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__oid-led.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__oid-led.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/led.h)
---

2
onlp/applications/module.md
View File

@@ -14,7 +14,7 @@ The current status of a module is queried using ```onlp_module_info_get``` to po
There are no module-specific fields in this structure as it is just a dynamic container for child OIDs. Those children can then be inspected and enumerated recursively.
## Module Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__oid-module.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__oid-module.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/module.h)
---

2
onlp/applications/platform.md
View File

@@ -16,5 +16,5 @@ examine them directly in the case of system debugging or technical support.
While you can call this API it is usually invoked via the command line tools.
## Platform Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__platform.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__platform.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/platform.h)

2
onlp/applications/psu.md
View File

@@ -7,7 +7,7 @@ The current status and capabilities of a PSU are queried using ```onlp_psu_info_
PSU features include things like voltage, power, current, and type (AC or DC).
## PSU Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__oid-psu.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__oid-psu.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/psu.h)
---

2
onlp/applications/sfp.md
View File

@@ -45,7 +45,7 @@ Aggregating ```TX_FAULT``` might still be a useful but no bitmap API is currentl
## SFP Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__oid-sfp.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__oid-sfp.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/sfp.h)
---

2
onlp/applications/thermal.md
View File

@@ -7,7 +7,7 @@ The current status of a temperature sensors is queried using ```onlp_thermal_inf
Thermal features include current temperature and any warning or shutdown thresholds for the given sensor.
## Thermal Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/thermal_8h.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/thermal_8h.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/thermal.h)
---

2
onlp/implementors/attributei.md
View File

@@ -16,7 +16,7 @@ Supporting these on anything other than the Chassis OID is optional.
Should a FRU or Module support either of these attributes then you are encouraged to support them on those OIDs as well.
## Attributei Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__attributei.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__attributei.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/platformi/attributei.h)
---

2
onlp/implementors/chassisi.md
View File

@@ -16,7 +16,7 @@ There are no fields currently defined in the ```onlp_chassis_info_t``` structure
The current default implementation of ```onlp_chassisi_info_get()``` does this for you and there is no need to provide this function at this time.
# Chassisi Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__chassisi.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__chassisi.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/platformi/chassisi.h)
* [Example Implementation](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/platforms/accton/x86-64/as7712-32x/onlp/builds/x86_64_accton_as7712_32x/module/src/chassisi.c)

2
onlp/implementors/fani.md
View File

@@ -23,7 +23,7 @@ If the SET capability flags are set by ```onlp_fani_info_get()``` then the ```on
They will not be called unless the capabilities are reported.
## Fani Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__fani.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__fani.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/platformi/fani.h)
* [Example Implementation](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/platforms/accton/x86-64/as7712-32x/onlp/builds/x86_64_accton_as7712_32x/module/src/fani.c)

2
onlp/implementors/generici.md
View File

@@ -21,7 +21,7 @@ While the Generic OID can be a parent container for other OIDs it is generally d
There are no defined behaviors for the Generic OID.
# Generici Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__generici.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__generici.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/platformi/genericii.h)

2
onlp/implementors/ledi.md
View File

@@ -20,7 +20,7 @@ If the SET capability flags are set by ```onlp_ledi_info_get()``` then the ```on
They will not be called unless the capabilities are reported.
## Ledi Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__ledi.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__ledi.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/platformi/ledi.h)
* [Example Implementation](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/platforms/accton/x86-64/as7712-32x/onlp/builds/x86_64_accton_as7712_32x/module/src/ledi.c)

2
onlp/implementors/modulei.md
View File

@@ -24,7 +24,7 @@ Think linecard or module port chassis.
Modules heirarchies are visible to the user.
# Modulei Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__modulei.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__modulei.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/platformi/moduleii.h)

2
onlp/implementors/platformi.md
View File

@@ -52,7 +52,7 @@ and shown to the user.
This interface is optional.
## Platformi Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__platformi.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__platformi.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/platformi/platformi.h)
* [Example Implementation](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/platforms/accton/x86-64/as7712-32x/onlp/builds/x86_64_accton_as7712_32x/module/src/platformi.c)

2
onlp/implementors/psui.md
View File

@@ -25,7 +25,7 @@ This returns the full information structure for the PSU. This includes the capab
There are no defined APIs for setting any PSU values. This may change in the future.
## PSUi Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__psui.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__psui.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/platformi/psui.h)
* [Example Implementation](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/platforms/accton/x86-64/as7712-32x/onlp/builds/x86_64_accton_as7712_32x/module/src/psui.c)

2
onlp/implementors/sfpi.md
View File

@@ -35,7 +35,7 @@ All sfpi_dev_{read,readb,readw,write,writeb,writew} functions should be implemen
A proper implementation of the Control API is necessary. Do not skip support for all available control fields, either get or set where applicable.
## SFPi Documentation
* [Doxygen](http://ocp.opennetlinux.org/onlp/group__sfpi.html)
* [Doxygen](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/group__sfpi.html)
* [Header](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/base/any/onlp/src/onlp/module/inc/onlp/platformi/sfpi.h)
* [Example Implementation](https://github.com/opencomputeproject/OpenNetworkLinux/blob/ONLPv2/packages/platforms/accton/x86-64/as7712-32x/onlp/builds/x86_64_accton_as7712_32x/module/src/sfpi.c)

2
onlp/index.md
View File

@@ -16,4 +16,4 @@ The ONLP API user documentation for Platform developers who which to implement s
## ONLP API Reference
The ONLP Reference Documentation is maintained using Doxygen and can be browsed [here](http://ocp.opennetlinux.org/onlp/index.html).
The ONLP Reference Documentation is maintained using Doxygen and can be browsed [here](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/doxygen/html/index.html).