Commit a09474dd authored by Rich Salz's avatar Rich Salz
Browse files

Some cleanup of L<> markup in pod files 



Show only the #define, not the values, in BIO_f_buffer.  Data
abstraction and we can remove a "see also" entry.

Remove internal forward reference to NOTES in EVP_EncryptInit; just
say "see below" as we do in the other pages.

Add missing (3) in pem.pod so the L<> entry is consistent.
Fix entry to point to the "master" page, not the symlink'd one.

Reviewed-by: default avatarMatt Caswell <matt@openssl.org>
parent 41cd41c4

doc/crypto/BIO_f_buffer.pod

+6 −7
Original line number Diff line number Diff line
@@ -10,11 +10,11 @@ BIO_f_buffer - buffering BIO 


 BIO_METHOD * BIO_f_buffer(void);



 #define BIO_get_buffer_num_lines(b)	BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL)

 #define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0)

 #define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1)

 #define BIO_set_buffer_size(b,size)	BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL)

 #define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf)

 #define BIO_get_buffer_num_lines(b)

 #define BIO_set_read_buffer_size(b,size)

 #define BIO_set_write_buffer_size(b,size)

 #define BIO_set_buffer_size(b,size)

 #define BIO_set_buffer_read_data(b,buf,num)



=head1 DESCRIPTION
@@ -70,5 +70,4 @@ L<BIO(3)|BIO(3)>, 
L<BIO_reset(3)|BIO_reset(3)>,

L<BIO_flush(3)|BIO_flush(3)>,

L<BIO_pop(3)|BIO_pop(3)>,

L<BIO_ctrl(3)|BIO_ctrl(3)>,

L<BIO_int_ctrl(3)|BIO_ctrl(3)>
 
L<BIO_ctrl(3)|BIO_ctrl(3)>.

doc/crypto/EVP_EncryptInit.pod

+2 −1
Original line number Diff line number Diff line
@@ -133,7 +133,8 @@ room. The actual number of bytes written is placed in B<outl>. 


If padding is enabled (the default) then EVP_EncryptFinal_ex() encrypts

the "final" data, that is any data that remains in a partial block.

It uses L<standard block padding|/NOTES> (aka PKCS padding). The encrypted

It uses standard block padding (aka PKCS padding) as described in

the NOTES section, below. The encrypted

final data is written to B<out> which should have sufficient space for

one cipher block. The number of bytes written is placed in B<outl>. After

this function is called the encryption operation is finished and no further

doc/crypto/pem.pod

+1 −1
Original line number Diff line number Diff line
@@ -477,4 +477,4 @@ The write routines return 1 for success or 0 for failure. 


=head1 SEE ALSO



L<EVP_get_cipherbyname(3)|EVP_get_cipherbyname>, L<EVP_BytesToKey(3)|EVP_BytesToKey(3)>
 
L<EVP_get_cipherbyname(3)|EVP_EncryptInit(3)>, L<EVP_BytesToKey(3)|EVP_BytesToKey(3)>