Skip to content

Commit

Permalink
Merge pull request RIOT-OS#4787 from BytesGalore/doc_crypto_add_word_…
Browse files Browse the repository at this point in the history
…on_required_cflags

doc crypto: add word on using required `CFLAGS`
  • Loading branch information
cgundogan committed Mar 3, 2016
2 parents cdd6878 + d09ae8f commit e70c5d4
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions sys/crypto/doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@
* While you can use the ciphers functions directly, you should resort to
* the generic API for block ciphers whenever possible.
*
* Additionally you need to set a CFLAG for each cipher you want to use in your Makefile:
* * AES-128: CFLAGS += -DCRYPTO_AES
* * 3DES: CFLAGS += -DCRYPTO_THREEDES
* * Twofish: CFLAGS += -DCRYPTO_TWOFISH
* Setting the CFLAGS initializes a sufficient large buffer size of the cipher_context_t,
* used by the ciphers for en-/de-cryption operations.
*
* Example:
* @code
* #include "crypto/ciphers.h"
Expand Down

0 comments on commit e70c5d4

Please sign in to comment.