Nick Kew wrote:
>
> >> 3.2 Market/Requester
> >>    mod_proxy_html has been requested by Web Stack users and
> >>    by the originator.
> >
> >What does "and by the originator" means above?
> 
> I proposed these and other modules myself last year!

Ah.. the question is more about what are the business reasons or
customers who are driving the feature request. Engineers working on
the product itself "don't count".  This isn't an area ARC reviews
though (choice of components to support is a business decision) so
doesn't really matter, here.

> >Unless we expect customers to directly link against these, the shared
> >library files themselves may not be public interfaces.
> 
> Indeed, I was going by the guidelines that suggested every new file
> should be listed under "Interfaces".

Where did you see those guidelines? If that's written somewhere I
should go and try get it fixed.

Public interfaces in the context of architectural review refer to
those which we choose to allow (read: support) customers to depend on.

An rule of thumb to decide if 'x' is a public interface is whether we
intend to document it and support (accept bug reports from) customers
writing something which depend on 'x'.

Most files delivered by most packages are not public interfaces,
they're just implementation detail (aka Project Private interface).

Note that while some files are public interfaces, most interfaces are
not files. Interfaces can be anything some other code depends on. API
signatures, semantics, return codes, CLI names & arguments, config
file syntax, directives, etc.


> You mean every directive for the two modules needs to be
> included in the ARC case (as opposed to referenced in an existing
> web page that documents them)?

Each of the directives is an interface, yes.  It's not necessarily
required to list them all in this document, referencing some other
authoritative document which defines them is ok too. 

I see in the latest draft they are listed individually; that is
certainly ok as well.


-- 
Jyri J. Virkki - jyri.virkki at sun.com - Sun Microsystems

Reply via email to