From watchman@ludd.luth.se  Tue Oct 21 13:02:24 2003
Return-Path: <watchman@ludd.luth.se>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id EA6EC16A4B3
	for <FreeBSD-gnats-submit@freebsd.org>; Tue, 21 Oct 2003 13:02:24 -0700 (PDT)
Received: from smtp10.hy.skanova.net (smtp10.hy.skanova.net [195.67.199.143])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 87DF843FBF
	for <FreeBSD-gnats-submit@freebsd.org>; Tue, 21 Oct 2003 13:02:23 -0700 (PDT)
	(envelope-from watchman@ludd.luth.se)
Received: from fetis.ninja.se (h183n1fls23o947.bredband.comhem.se [217.211.160.183])
	by smtp10.hy.skanova.net (8.12.10/8.12.10) with ESMTP id h9LK2Mgr003200
	for <FreeBSD-gnats-submit@freebsd.org>; Tue, 21 Oct 2003 22:02:22 +0200 (CEST)
Message-Id: 1066766533@fetis.ninja.se
Date: Tue, 21 Oct 2003 22:02:24 +0200
From: "Joachim Strombergson" <watchman@ludd.luth.se>
To: FreeBSD-gnats-submit@freebsd.org
Subject: Wrong include path in man (9) for rijndael
X-Send-Pr-Version: gtk-send-pr 0.1 
X-GNATS-Notify:

>Number:         58347
>Category:       docs
>Synopsis:       Wrong include path in man (9) for rijndael
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    hmp
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Oct 21 13:10:12 PDT 2003
>Closed-Date:    Wed Oct 22 03:01:27 PDT 2003
>Last-Modified:  Wed Oct 22 03:01:27 PDT 2003
>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@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:
Responsible-Changed-From-To: freebsd-doc->hmp 
Responsible-Changed-By: hmp 
Responsible-Changed-When: Wed Oct 22 02:57:16 PDT 2003 
Responsible-Changed-Why:  
I will commit a fix. 


http://www.freebsd.org/cgi/query-pr.cgi?pr=58347 
State-Changed-From-To: open->closed 
State-Changed-By: hmp 
State-Changed-When: Wed Oct 22 03:01:16 PDT 2003 
State-Changed-Why:  
Fix has been committed, thanks! 


http://www.freebsd.org/cgi/query-pr.cgi?pr=58347 
>Unformatted:
