delorie.com/archives/browse.cgi   search  
Mail Archives: djgpp/1998/02/02/18:29:23

Date: Mon, 2 Feb 1998 19:02:33 +0200 (IST)
From: Eli Zaretskii <eliz AT is DOT elta DOT co DOT il>
To: Myknees AT aol DOT com
cc: dj AT delorie DOT com, djgpp AT delorie DOT com
Subject: Re: Documentation [was Re: Random implementation]
In-Reply-To: <b8ad4e96.34d4e87b@aol.com>
Message-ID: <Pine.SUN.3.91.980202190155.19322I@is>
MIME-Version: 1.0

On Sun, 1 Feb 1998 Myknees AT aol DOT com wrote:

> Everything below the equals line is output from diff.

You don't need to tell this.  `patch' (the program used to apply the
diffs to source files) knows how to find the place where the diffs
begin.

> *** rand.txh	Mon Jul 10 01:39:56 1995
> --- rand3.txh	Sun Feb  1 16:15:10 1998

Please run diff so that the file names begin from the top-level DJGPP
directory.  For example:

  diff -c src/libc/ansi/stdlib/rand.old src/libc/ansi/stdlib/rand.txh

This makes applying the diffs easier.  The way you did it requires to
find the directory where rand.txh lives and chdir there, before
running `patch'.

Also please note that it is best to name the *new* version with the
correct name, not the old one (it makes the operation of `patch' less
error-prone).  See the example above.

> ! n AT subheading Syntax
    ^
I presume this `n' is a typo.

> + This function has its own default seed but may also be seeded with the
> + function @code{srand} (found in the @code{rand} source file).
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
There's no need to tell where in the sources is `srand'; the libc docs
doesn't discuss sources at all.

If you want to refer to another function, use cross-references, like
this:

  This function has its own default seed but may also be seeded with the
  function @code{srand} (@pxref{srand}).

This generates a hyper-link to the documentation of `srand'.

> + @example
> + /* seed @code{rand} with current time */
> + srand(time(0));
>   @end example

You don't need to use the @code{} tag here, since everything inside
@example is typeset with the same font as @code invokes.

- Raw text -


  webmaster     delorie software   privacy  
  Copyright © 2019   by DJ Delorie     Updated Jul 2019