Skip to content

Commit 2826632

Browse files
committed
Add some notes about new symbols to CONTRIBUTING.md
1 parent 3436070 commit 2826632

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,16 @@ typedef enum
9595
} my_flags_t;
9696
```
9797

98+
### Adding a new symbol
99+
100+
This should be done rarely but there are several things that you need to do
101+
when adding a new symbol.
102+
103+
- Add the symbol to `src/libmongoc.symbols`
104+
- Add the symbol to `build/autotools/versions.ldscript`
105+
- Add the symbol to `build/cmake/libmongoc.def`
106+
- Add the symbol to `build/cmake/libmongoc-ssl.def`
107+
- Add documentation for the new symbol in `doc/mongoc_your_new_symbol_name.page`
98108

99109
### Documentation
100110

0 commit comments

Comments
 (0)