[gentoo-dev] rfc: OpenRC public API definition

[gentoo-dev] rfc: OpenRC public API definition

[William Hubbs]

[-- Attachment #1: Type: text/plain, Size: 454 bytes --]

All,

I would like opinions on what is considered the public api of librc.

1) All definitions in rc.h, even though they are not formally documented
in man pages.

2) the definitions in rc.h which are documented in section 3 man pages.

I'm bringing this up, because I am looking at redesigning one of the
undocumented functions soon, and the redesign will definitely break
things if people are using the function outside of OpenRC.

Thoughts?

William


[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 181 bytes --]

Re: [gentoo-dev] rfc: OpenRC public API definition

[Patrick Lauer]

On 12/03/2015 06:36 PM, William Hubbs wrote:
> All,
>
> I would like opinions on what is considered the public api of librc.
>
> 1) All definitions in rc.h, even though they are not formally documented
> in man pages.
Yes.
The header *is* the public API.
>
> 2) the definitions in rc.h which are documented in section 3 man pages.
>
> I'm bringing this up, because I am looking at redesigning one of the
> undocumented functions soon, and the redesign will definitely break
> things if people are using the function outside of OpenRC.
>
> Thoughts?
>
> William
>

Re: [gentoo-dev] rfc: OpenRC public API definition

[Michael Orlitzky]

On 12/03/2015 12:36 PM, William Hubbs wrote:
> All,
> 
> I would like opinions on what is considered the public api of librc.
> 
> 1) All definitions in rc.h, even though they are not formally documented
> in man pages.
> 
> 2) the definitions in rc.h which are documented in section 3 man pages.
> 
> I'm bringing this up, because I am looking at redesigning one of the
> undocumented functions soon, and the redesign will definitely break
> things if people are using the function outside of OpenRC.
> 

It's OK to change the public API as long as it's in a major version so
nobody is surprised.

Re: [gentoo-dev] rfc: OpenRC public API definition

[Mike Frysinger]

[-- Attachment #1: Type: text/plain, Size: 649 bytes --]

On 03 Dec 2015 11:36, William Hubbs wrote:
> 1) All definitions in rc.h, even though they are not formally documented
> in man pages.

this.  if it's not meant to be public, it should have been in librc.h or
a similar internal header.

> I'm bringing this up, because I am looking at redesigning one of the
> undocumented functions soon, and the redesign will definitely break
> things if people are using the function outside of OpenRC.

bump the SONAME and forget about it.  as mentioned in the other thread,
there's not really any consumers today.  plus, i'm pretty sure we've
broken things a bit in the past but no one noticed/complained.
-mike

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]