Bug 46365

Summary: there is no documentation on getosreldate(3)
Product: Documentation Reporter: Sebastien Gioria <gioria>
Component: Books & ArticlesAssignee: Tom Rhodes <trhodes>
Status: Closed FIXED    
Severity: Affects Only Me CC: alfred
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
getosreldate.3
none
getosreldate.3
none
getosreldate.3 none

Description Sebastien Gioria freebsd_committer freebsd_triage 2002-12-18 23:40:01 UTC 
	The getosreldate(3) function is not documented in the manual pages

Fix: This is a roff file documenting the getosreldate function
How-To-Repeat: 	do a man getosreldate
Comment 1 Sebastien Gioria freebsd_committer freebsd_triage 2002-12-18 23:43:40 UTC 
Oups..... did not include the good man page....


-- 
Sebastien Gioria(48.8147,2.3622)   gioria@{FreeBSD,FreeBSD-FR}.ORG
French FreeBSD User Group    	         http://www.FreeBSD-FR.ORG
FreeBSD committer			    http://www.FreeBSD.ORG
*-> FreeBSD + RollerBlade + Scuba Diving; What need you more ? <-*
Comment 2 Giorgos Keramidas freebsd_committer freebsd_triage 2002-12-19 15:16:53 UTC 
On 2002-12-19 00:43, Sebastien Gioria <gioria@FreeBSD.ORG> wrote:

> .Sh DESCRIPTION
> .Fn getosreldate

> .Sh HISTORY
> The
> .Fn getosreldate
> appeared in
> .Fx 2.0.

You don't need to include the function name after .Fn here.
These two are probably better if written as:

	The
	.Fn
	function...

> at http://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/freebsd-versions.html
> .Sh EXAMPLES
> An example can be found in /usr/share/examples/FreeBSD_version

	An example can be found in
	.Pa /usr/share/examples/FreeBSD_version .

Paths look nicer if marker up with .Pa in output formats that can use
many fonts.  I'm not sure if the URL can be marked up with .Pa too,
but Ruslan will probably know better.
Comment 3 Sebastien Gioria freebsd_committer freebsd_triage 2003-01-02 20:42:12 UTC 
On Thu, 19 Dec 2002 17:16:53 +0200 the keyboard of Giorgos Keramidas <keramida@freebsd.org> wrote:

> On 2002-12-19 00:43, Sebastien Gioria <gioria@FreeBSD.ORG> wrote:
> 
> > .Sh DESCRIPTION
> > .Fn getosreldate
> 
> > .Sh HISTORY
> > The
> > .Fn getosreldate
> > appeared in
> > .Fx 2.0.
> 
> You don't need to include the function name after .Fn here.
> These two are probably better if written as:
> 
> 	The
> 	.Fn
> 	function...
> 
> > at http://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/freebsd-versions.html
> > .Sh EXAMPLES
> > An example can be found in /usr/share/examples/FreeBSD_version
> 
> 	An example can be found in
> 	.Pa /usr/share/examples/FreeBSD_version .
> 
> Paths look nicer if marker up with .Pa in output formats that can use
> many fonts.  I'm not sure if the URL can be marked up with .Pa too,
> but Ruslan will probably know better.

After your remarks, the man page look like this 

This seem to have some probleme doing just 
.Fn
function... . 

So you mustdo 

.Fn nameofyourfunction


-- 
Sebastien Gioria(48.8147,2.3622)   gioria@{FreeBSD,FreeBSD-FR}.ORG
French FreeBSD User Group    	         http://www.FreeBSD-FR.ORG
FreeBSD committer			    http://www.FreeBSD.ORG
*-> FreeBSD + RollerBlade + Scuba Diving; What need you more ? <-*
Comment 4 Tom Rhodes freebsd_committer freebsd_triage 2003-01-30 22:41:38 UTC 
State Changed
From-To: open->patched

I've taken the various comments and committed a slightly different version 
of your manual page.  Thanks for doing this!
Comment 5 Tom Rhodes freebsd_committer freebsd_triage 2003-01-30 22:41:38 UTC 
Responsible Changed
From-To: freebsd-doc->trhodes

I've taken the various comments and committed a slightly different version 
of your manual page.  Thanks for doing this!
Comment 6 Tom Rhodes freebsd_committer freebsd_triage 2003-02-02 03:14:07 UTC 
State Changed
From-To: patched->closed

Committed!  Thanks for the submission!