<commit_before>CMPI header files
=================

The [cmpi-headers project on GitHub](https://github.com/cmpi-wg/cmpi-headers)
maintains the C/C++ header files of the OpenGroup CMPI Standard.

CMPI stands for "Common Manageability Programming Interface" and is a C-language
API between a Management Broker (aka CIMOM) and Management Instrumentation (aka
Providers). CMPI supports the CIM and WBEM standards defined by
[DMTF](http://www.dmtf.org).

The CMPI Standard (that is, the document) is maintained on the
[CMPI Working Group web space](https://wiki.opengroup.org/councils-wiki/doku.php?id=forums:enterprise_management:cmpi:start).

Status
------

At this point, version 2.1 of the CMPI Standard is being finalized, and the
CMPI header files are nearly done as well.

The header files are enabled for generating documentation using Doxygen. The
goal is to generate the documentation automatically and to publish it on
[readthedocs.org](https://readthedocs.org/). This has not been established yet
but is supposed to happen soon.

Feedback and contributions
--------------------------

Feedback on the CMPI header files is welcome. Please provide any feedback via
the issue tracker of the
[cmpi-headers project on GitHub](https://github.com/cmpi-wg/cmpi-headers).

Contributions to the CMPI header files are welcome as well, specifically
contributions to the examples in the function descriptions of the header files.
For now, it is suggested that contributions be made also via the issue tracker.

The Open Group rules on feedback and contributions apply, as documented in the
CMPI Standard.

Note that feedback on the CMPI Standard itself should be made as directed in
the CMPI Standard.

License
-------

See [LICENSE.md](LICENSE.md)<commit_msg>Updated information about readthedocs and doxagen generated HTML in github readme.<commit_after>CMPI header files
=================

The [cmpi-headers project on GitHub](https://github.com/cmpi-wg/cmpi-headers)
maintains the C/C++ header files of the OpenGroup CMPI Standard.

CMPI stands for "Common Manageability Programming Interface" and is a C-language
API between a Management Broker (aka CIMOM) and Management Instrumentation (aka
Providers). CMPI supports the CIM and WBEM standards defined by
[DMTF](http://www.dmtf.org).

The CMPI Standard (that is, the document) is maintained on the
[CMPI Working Group web space](https://wiki.opengroup.org/councils-wiki/doku.php?id=forums:enterprise_management:cmpi:start).

The CMPI header files are enabled for generating documentation using Doxygen.
You can generate your own copy of the CMPI documentation by cloning this Github
repository and running the `doxygen` command in the project's root directory,
after creating a 'doxygen' output directory. It requires Doxygen v1.8.6 or
higher and being on a Linux system. This will generate HTML output (open
doxygen/html/index.html) and LaTex output for further processing into PDF (see
doxygen/latex/).
 
The CMPI header files are also published on
[cmpi-headers.readthedocs.org](https://cmpi-headers.readthedocs.org/). They are
updated automatically whenever files are changed in this Github project.
However, the generated HTML is not as nice as the direct Doxygen-generated HTML
at this point. We are working to improve that, but for now you're better off by
generating the Doxygen HTML yourself.

Status
------

At this point, version 2.1 of the CMPI Standard is being finalized, and the
CMPI header files are nearly done as well.

Feedback and contributions
--------------------------

Feedback on the CMPI header files is welcome. Please provide any feedback via
the issue tracker of the
[cmpi-headers project on GitHub](https://github.com/cmpi-wg/cmpi-headers).

Contributions to the CMPI header files are welcome as well, specifically
contributions to the examples in the function descriptions of the header files.
For now, it is suggested that contributions be made also via the issue tracker.

The Open Group rules on feedback and contributions apply, as documented in the
CMPI Standard.

Note that feedback on the CMPI Standard itself should be made as directed in
the CMPI Standard.

License
-------

See [LICENSE.md](LICENSE.md) (preliminary license)
{'fraction_non_alphanumeric': 0.08418306853213185, 'fraction_numerical': 0.0016599478302110505, 'mean_word_length': 4.3869731800766285, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 8, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7161177', 'n_tokens_mistral': 1181, 'n_tokens_neox': 1123, 'n_words': 547}