Commit 8d92311c authored by Rich Salz's avatar Rich Salz
Browse files

Fix many doc L<> errors 

Add 2017 copyright year
Add missing typedef to NAME
Remove ec(7) and bn(7) doc links
Remove .pod link errors, bogus links, make a few typo corrections
Fix some typo's in links and some missing items.
Don't link to C runtime functions (See OPENSSL_malloc for example/precedent)
Document ASN1_tag2str(), add a few typedef's that were missing from NAME
Update doc-nits target; addresses
    https://github.com/openssl/openssl/pull/1900#issuecomment-259943891,
Merge check-doc-links into find-doc-nits; if run regularly, would have found
    https://github.com/openssl/openssl/pull/2825



Reviewed-by: default avatarRichard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/2862)
(cherry picked from commit 9e183d22)
parent 1639a910

Configurations/unix-Makefile.tmpl

+5 −1
Original line number Diff line number Diff line
@@ -284,7 +284,7 @@ clean: libclean 
	-$(RM) `find . -name '*{- $depext -}' -a \! -path "./.git/*"`

	-$(RM) `find . -name '*{- $objext -}' -a \! -path "./.git/*"`

	$(RM) core

	$(RM) tags TAGS

	$(RM) tags TAGS doc-nits

	$(RM) test/.rnd

	$(RM) openssl.pc libcrypto.pc libssl.pc

	-$(RM) `find . -type l -a \! -path "./.git/*"`
@@ -581,6 +581,10 @@ update: generate errors ordinals 
generate: generate_apps generate_crypto_bn generate_crypto_objects \

          generate_crypto_conf generate_crypto_asn1



doc-nits:

	(cd $(SRCDIR); $(PERL) util/find-doc-nits.pl -n ) >doc-nits

	if [ -s doc-nits ] ; then cat doc-nits; rm doc-nits ; exit 1; fi



# Test coverage is a good idea for the future

#coverage: $(PROGRAMS) $(TESTPROGRAMS)

#	...

doc/crypto/ASN1_STRING_print_ex.pod

+6 −2
Original line number Diff line number Diff line
@@ -2,7 +2,8 @@ 


=head1 NAME



ASN1_STRING_print_ex, ASN1_STRING_print_ex_fp, ASN1_STRING_print - ASN1_STRING output routines

ASN1_tag2str, ASN1_STRING_print_ex, ASN1_STRING_print_ex_fp, ASN1_STRING_print

- ASN1_STRING output routines



=head1 SYNOPSIS
@@ -12,6 +13,7 @@ ASN1_STRING_print_ex, ASN1_STRING_print_ex_fp, ASN1_STRING_print - ASN1_STRING o 
 int ASN1_STRING_print_ex_fp(FILE *fp, const ASN1_STRING *str, unsigned long flags);

 int ASN1_STRING_print(BIO *out, const ASN1_STRING *str);



 const char *ASN1_tag2str(int tag);



=head1 DESCRIPTION
@@ -26,6 +28,8 @@ ASN1_STRING_print() prints B<str> to B<out> but using a different format to 
ASN1_STRING_print_ex(). It replaces unprintable characters (other than CR, LF)

with '.'.



ASN1_tag2str() returns a human-readable name of the specified ASN.1 B<tag>.



=head1 NOTES



ASN1_STRING_print() is a legacy function which should be avoided in new applications.
@@ -91,7 +95,7 @@ L<ASN1_tag2str(3)> 


=head1 COPYRIGHT



Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.

Copyright 2002-2017 The OpenSSL Project Authors. All Rights Reserved.



Licensed under the OpenSSL license (the "License").  You may not use

this file except in compliance with the License.  You can obtain a copy

doc/crypto/BN_BLINDING_new.pod

+1 −5
Original line number Diff line number Diff line
@@ -105,10 +105,6 @@ BN_BLINDING_get_flags() returns the currently set B<BN_BLINDING> flags 
BN_BLINDING_create_param() returns the newly created B<BN_BLINDING>

parameters or NULL on error.



=head1 SEE ALSO



L<bn(3)>



=head1 HISTORY



BN_BLINDING_thread_id() was first introduced in OpenSSL 1.0.0, and it
@@ -116,7 +112,7 @@ deprecates BN_BLINDING_set_thread_id() and BN_BLINDING_get_thread_id(). 


=head1 COPYRIGHT



Copyright 2005-2016 The OpenSSL Project Authors. All Rights Reserved.

Copyright 2005-2017 The OpenSSL Project Authors. All Rights Reserved.



Licensed under the OpenSSL license (the "License").  You may not use

this file except in compliance with the License.  You can obtain a copy

doc/crypto/BN_CTX_new.pod

+2 −2
Original line number Diff line number Diff line
@@ -57,7 +57,7 @@ replace use of BN_CTX_init with BN_CTX_new instead: 


=head1 SEE ALSO



L<bn(3)>, L<ERR_get_error(3)>, L<BN_add(3)>,

L<ERR_get_error(3)>, L<BN_add(3)>,

L<BN_CTX_start(3)>



=head1 HISTORY
@@ -66,7 +66,7 @@ BN_CTX_init() was removed in OpenSSL 1.1.0. 


=head1 COPYRIGHT



Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.

Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.



Licensed under the OpenSSL license (the "License").  You may not use

this file except in compliance with the License.  You can obtain a copy

doc/crypto/BN_add.pod

+2 −2
Original line number Diff line number Diff line
@@ -112,12 +112,12 @@ The error codes can be obtained by L<ERR_get_error(3)>. 


=head1 SEE ALSO



L<bn(3)>, L<ERR_get_error(3)>, L<BN_CTX_new(3)>,

L<ERR_get_error(3)>, L<BN_CTX_new(3)>,

L<BN_add_word(3)>, L<BN_set_bit(3)>



=head1 COPYRIGHT



Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.

Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.



Licensed under the OpenSSL license (the "License").  You may not use

this file except in compliance with the License.  You can obtain a copy