I just started working on making symlinks for all names in the NAME
section of every .pod file we're converting into manpages. The
benefit is that the manuals are available by function name, and users
won't have to try to guess the name of the manpage any more.
Applying some changes on 0.9.7-stable, I get messages like this:
installing man3/BIO_s_bio.3
ln:
"/home/levitte/cvswork/dev.openssl.org/installs/OpenSSL-0.9.7-stable/usr/local/ssl/man/man3/BIO_new_bio_pair.3":
Filen finns
installing man3/BIO_s_connect.3
ln:
"/home/levitte/cvswork/dev.openssl.org/installs/OpenSSL-0.9.7-stable/usr/local/ssl/man/man3/BIO_set_nbio.3":
Filen finns
installing man3/BIO_set_callback.3
"Filen finns" is swedish and means "file exists".
The explanation is that the functions that make each of those already
existing file names are mentioned twice. For some of them, it's just
a duplication of names within the same manual, those are easy to fix
(I'm doing it as I write). Some of them are a little more
problematic, however, and I don't know right now how to best handle
them:
grep -n -e BIO_new_bio_pair doc/crypto/*.pod /dev/null
doc/crypto/BIO_new_bio_pair.pod:5:BIO_new_bio_pair - create a new BIO pair
doc/crypto/BIO_new_bio_pair.pod:11: int BIO_new_bio_pair(BIO **bio1, size_t writebuf1,
BIO **bio2, size_t writebuf2);
doc/crypto/BIO_new_bio_pair.pod:15:BIO_new_bio_pair() creates a buffering BIO pair
based on the
doc/crypto/BIO_new_bio_pair.pod:25:BIO_new_bio_pair() does not check whether B<bio1>
or B<bio2> do point to
doc/crypto/BIO_new_bio_pair.pod:41: BIO_new_bio_pair(internal_bio, 0, network_bio, 0);
doc/crypto/BIO_s_bio.pod:6:BIO_set_write_buf_size, BIO_get_write_buf_size,
BIO_new_bio_pair,
doc/crypto/BIO_s_bio.pod:24: int BIO_new_bio_pair(BIO **bio1, size_t writebuf1, BIO
**bio2, size_t writebuf2);
doc/crypto/BIO_s_bio.pod:76:BIO_new_bio_pair() combines the calls to BIO_new(),
BIO_make_bio_pair() and
doc/crypto/bio.pod:47:L<BIO_new_bio_pair(3)|BIO_new_bio_pair(3)>,
grep -n -e BIO_set_nbio doc/crypto/*.pod /dev/null
doc/crypto/BIO_s_accept.pod:5:BIO_s_accept, BIO_set_nbio, BIO_set_accept_port,
BIO_get_accept_port,
doc/crypto/BIO_s_accept.pod:6:BIO_set_nbio_accept, BIO_set_accept_bios,
BIO_set_bind_mode,
doc/crypto/BIO_s_accept.pod:20: long BIO_set_nbio_accept(BIO *b, int n);
doc/crypto/BIO_s_accept.pod:72:BIO_set_nbio_accept() sets the accept socket to
blocking mode
doc/crypto/BIO_s_accept.pod:140:BIO_set_accept_port(), BIO_get_accept_port(),
BIO_set_nbio_accept(),
doc/crypto/BIO_s_connect.pod:8:BIO_set_nbio, BIO_do_connect - connect BIO
doc/crypto/BIO_s_connect.pod:27: long BIO_set_nbio(BIO *b, long n);
doc/crypto/BIO_s_connect.pod:86:BIO_set_nbio() sets the non blocking I/O flag to B<n>.
If B<n> is
doc/crypto/BIO_s_connect.pod:88:is set. Blocking I/O is the default. The call to
BIO_set_nbio()
doc/crypto/BIO_s_connect.pod:133:BIO_get_conn_ip(), BIO_get_conn_int_port(),
BIO_set_nbio() and
doc/crypto/BIO_s_connect.pod:158:BIO_set_nbio() always returns 1.
--
Richard Levitte \ Spannvägen 38, II \ [EMAIL PROTECTED]
Redakteur@Stacken \ S-168 35 BROMMA \ T: +46-8-26 52 47
\ SWEDEN \ or +46-708-26 53 44
Procurator Odiosus Ex Infernis -- [EMAIL PROTECTED]
Member of the OpenSSL development team: http://www.openssl.org/
Unsolicited commercial email is subject to an archival fee of $400.
See <http://www.stacken.kth.se/~levitte/mail/> for more info.
______________________________________________________________________
OpenSSL Project http://www.openssl.org
Development Mailing List [EMAIL PROTECTED]
Automated List Manager [EMAIL PROTECTED]
