mirror of
https://github.com/eclipse/upm.git
synced 2025-03-14 20:47:30 +03:00
naming.md: update documentation for naming
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
parent
3bea0233bc
commit
8e11768a51
@ -2,20 +2,25 @@ Naming a module {#naming}
|
||||
===============
|
||||
|
||||
UPM attemps to follow a clear naming pattern. Modules should be sensibly named
|
||||
and then placed in /usr/lib/upm and headers in /usr/include/upm.
|
||||
and then placed in ${libdir}/upm and headers in ${includedir}/upm, all modules
|
||||
should be prefixed with libupm-<modulename>. The upm_module_init will
|
||||
automatically name python UPM modules as pyupm_<modulename> and javascript
|
||||
modules as jsupm_<modulename>. For example for src/grove/ the library built
|
||||
will be libupm-grove.so, the python module pyupm_grove and the js module
|
||||
jsupm_grove.
|
||||
|
||||
### Choosing a name
|
||||
### Choosing a name for a new module
|
||||
|
||||
1. Pick a name
|
||||
2. Use it
|
||||
1. Pick a name, typically the chip name is the most sensible
|
||||
2. Use it & stick to it
|
||||
|
||||
### Rules for name picking
|
||||
|
||||
1. Your lib must belong to namespace UPM
|
||||
2. Usually picking the name of the chip of your sensor/actuator might make
|
||||
sense. Other times this does not. Try to pick a generic name so people with a
|
||||
similar sensor can inherit your class if they only have minor changes.
|
||||
3. Avoid brand names
|
||||
1. Your lib must belong to the UPM namespace
|
||||
2. Usually picking the name of the chip of your sensor/actuator makes sense.
|
||||
Other times this does not. Try to pick a generic name so people with a similar
|
||||
sensor can inherit your class if they only have minor changes.
|
||||
3. Avoid brand names, often your module can be very generic with little effort
|
||||
|
||||
### Doubt
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user