docs/58347: Wrong include path in man (9) for rijndael

[Joachim Strombergson]

>Number:         58347
>Category:       docs
>Synopsis:       Wrong include path in man (9) for rijndael
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Oct 21 13:10:12 PDT 2003
>Closed-Date:
>Last-Modified:
>Originator:     Joachim Strombergson
>Release:        FreeBSD 5.1-CURRENT i386
>Organization:
>Environment:


System: FreeBSD fetis.ninja.se 5.1-CURRENT FreeBSD 5.1-CURRENT #13: Sun Sep 28 11:03:31 CEST 2003     js at fetis.ninja.se:/usr/obj/usr/src/sys/ATHLON i386  


>Description:


The manual page for rijndael contains an include path that is incorrect. The manual states:

SYNOPSIS
     #include <sys/types.h>
     #include <crypto/rijndael/rijndael.h>

But, Rijndael is actually locates in:
/usr/include/crypto/rijndael.h

That is, in the crypto subdir, not in a specific Rijndael directory.


>How-To-Repeat:


man rijndael and then try to use the includes found in the man page in an application that uses Rijndael:

<qote>
gcc -O -o testRijndael rijndael_regtest.c
rijndael_regtest.c:20:38: crypto/rijndael/rijndael.h: No such file or directory
*** Error code 1
</quote>



>Fix:


Apply the following patch:

--- /usr/src/share/man/man9/rijndael.9  Fri Apr 12 07:23:16 2002
+++ /usr/src/share/man/man9/rijndael.9  Tue Oct 21 21:58:58 2003
@@ -39,7 +39,7 @@
 .Nd AES encryption
 .Sh SYNOPSIS
 .In sys/types.h
-.In crypto/rijndael/rijndael.h
+.In crypto/rijndael.h
 .Ft int
 .Fo rijndael_makeKey
 .Fa "keyInstance *key"



>Release-Note:
>Audit-Trail:
>Unformatted: