alarsyo/spot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

* HACKING: Typos.

Browse source
This commit is contained in:
Alexandre Duret-Lutz 2013-11-28 18:44:28 +01:00
parent d719c706f4
commit 0fc189d186
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
HACKING
View file

@ -252,23 +252,23 @@ Exporting symbols
should still be private to the library, use a *.hh/*.cc pair of should still be private to the library, use a *.hh/*.cc pair of
files, but list both files in the _SOURCES variable of that files, but list both files in the _SOURCES variable of that
directory (see for instance weight.hh in tgbaalgos/Makefile.am). directory (see for instance weight.hh in tgbaalgos/Makefile.am).
This will ensure that weight.hh is not installed. This will ensure that the header is not installed.
Needless to say, no public header should include such private Needless to say, no public header should include such a private
header. header.
* The directory src/priv/ can be used to store file that are globaly * The directory src/priv/ can be used to store files that are
private the library, and that do not really fit belongs to other globaly private the library, and that do not really belongs to
directories. other directories.
* Functions and classes that are public should be marked with * Functions and classes that are public should be marked with
the SPOT_API macro. This macro is defined in misc/common.hh, the SPOT_API macro. This macro is defined in misc/common.hh,
but you need not include it in a file that already include but you need not include it in a file that already includes
another public header. another public header.
* Do not make a symbol public just because you can. * Do not make a symbol public just because you can.
* Read http://www.akkadia.org/drepper/dsohowto.pdf for more * Read http://www.akkadia.org/drepper/dsohowto.pdf for more
information about how shared library work and why information about how shared libraries work and why.
Comments Comments
-------- --------