#47626 validate/update code examples
Closed: wontfix None Opened 10 years ago by rmeggins.

We recently went through a lot of trouble trying to diagnose a customer problem with a custom plugin. The customer was just copying/pasting our official documentation, which turns out is wrong. We need to validate all of our published code examples:
1) make sure they build without warnings/errors
2) make sure they use the latest API functions
3) make sure they actually work as intended
4) create a Makefile to use that will have a high warning level, and will check all of the functions used - something like -z defs

One of the problems the customer had was that they were using the wrong function name (because of the erroneous documentation). The function was not defined, and the compiler only gave a warning (if any). Either the warning should be a hard error, or we need to tell the linker to give an error (like ld -z defs).


Text doc with documentation amendments
plugin-doc

Metadata Update from @mreynolds:
- Issue assigned to mreynolds
- Issue set to the milestone: 1.3.3 backlog

7 years ago

389-ds-base is moving from Pagure to Github. This means that new issues and pull requests
will be accepted only in 389-ds-base's github repository.

This issue has been cloned to Github and is available here:
- https://github.com/389ds/389-ds-base/issues/963

If you want to receive further updates on the issue, please navigate to the github issue
and click on subscribe button.

Thank you for understanding. We apologize for all inconvenience.

Metadata Update from @spichugi:
- Issue close_status updated to: wontfix (was: Fixed)

3 years ago

Login to comment on this ticket.

Metadata