OSDN Git Service

libjava/classpath/
authorrwild <rwild@138bc75d-0d04-0410-961f-82ee72b054a4>
Sun, 9 Mar 2008 17:31:22 +0000 (17:31 +0000)
committerrwild <rwild@138bc75d-0d04-0410-961f-82ee72b054a4>
Sun, 9 Mar 2008 17:31:22 +0000 (17:31 +0000)
* doc/cp-hacking.texinfo: Fix spacing after periods.
* doc/cp-tools.texinfo: Likewise.
* doc/cp-vmintegration.texinfo: Likewise.

git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@133058 138bc75d-0d04-0410-961f-82ee72b054a4

libjava/classpath/ChangeLog
libjava/classpath/doc/cp-hacking.texinfo
libjava/classpath/doc/cp-tools.texinfo
libjava/classpath/doc/cp-vmintegration.texinfo

index 8734c25..1a39f6b 100644 (file)
@@ -1,5 +1,9 @@
 2008-03-09  Ralf Wildenhues  <Ralf.Wildenhues@gmx.de>
 
+       * doc/cp-hacking.texinfo: Fix spacing after periods.
+       * doc/cp-tools.texinfo: Likewise.
+       * doc/cp-vmintegration.texinfo: Likewise.
+
        * doc/cp-hacking.texinfo: Fix some typos.
        * doc/cp-tools.texinfo: Likewise.
        * doc/cp-vmintegration.texinfo: Likewise.
index 1f9b5c1..ee2b8f5 100644 (file)
@@ -303,7 +303,7 @@ Classpath stories page}.
 
 As with OS platform support, this priority list could change if a
 volunteer comes forward to port, maintain, and test releases for a
-particular JVM.  Since gcj is part of the GNU Compiler Collective it
+particular JVM@.  Since gcj is part of the GNU Compiler Collective it
 is one of the most important targets.  But since it doesn't currently
 work out of the box with GNU Classpath it is currently not the easiest
 target.  When hacking on GNU Classpath the easiest is to use
@@ -952,7 +952,7 @@ use @code{+Predundant-modifiers} on the command line.
 
 @item
 Modifiers should be listed in the standard order recommended by the
-JLS.  Jikes will warn for this when given @code{+Pmodifier-order}.
+JLS@.  Jikes will warn for this when given @code{+Pmodifier-order}.
 
 @item
 Because the output of different compilers differs, we have
@@ -1002,7 +1002,7 @@ words which have been added in later versions.  Notable examples are
 @code{assert} (added in 1.4) and @code{enum} (added in 1.5).  Jikes will warn
 of the use of the word @code{enum}, but, as it doesn't yet support the 1.5
 version of the language, it will still allow this usage through.  A
-compiler which supports 1.5 (e.g. the Eclipse compiler, ecj) will simply
+compiler which supports 1.5 (e.g.@: the Eclipse compiler, ecj) will simply
 fail to compile the offending source code.
 
 @c fixme Describe Anonymous classes (example).
@@ -1073,7 +1073,7 @@ You can find instructions on getting a CVS checkout for classpath at
 
 You don't have to get CVS commit write access to contribute, but it is
 sometimes more convenient to be able to add your changes directly to
-the project CVS. Please contact the GNU Classpath savannah admins to
+the project CVS@. Please contact the GNU Classpath savannah admins to
 arrange CVS access if you would like to have it.
 
 Make sure to be subscribed to the commit-classpath mailinglist while
index 21a8e57..9e370c0 100644 (file)
@@ -338,7 +338,7 @@ jarsigner @option{-verify} [@var{OPTION}]@dots{} @var{FILE}
 @c man begin DESCRIPTION gjarsigner
 When the first form is used, the tool signs the designated JAR file. The second form, on the other hand, is used to verify a previously signed JAR file.
 
-@var{FILE} is the .JAR file to process; i.e. to sign if the first syntax form is used, or to verify if the second syntax form is used instead.
+@var{FILE} is the .JAR file to process; i.e., to sign if the first syntax form is used, or to verify if the second syntax form is used instead.
 
 @var{ALIAS} must be a known @i{Alias} of a @i{Key Entry} in the designated @i{Key Store}. The private key material associated with this @i{Alias} is then used for signing the designated .JAR file.
 @c man end
@@ -369,7 +369,7 @@ When present, the tool will include --which otherwise it does not-- the @code{.S
 When present, the tool will include in the @code{.SF} generated file --which otherwise it does not-- a header containing a hash of the whole manifest file.  When that header is included, the tool can quickly check, during verification, if the hash (in the header) matches or not the manifest file.
 
 @item -provider PROVIDER_CLASS_NAME
-A fully qualified class name of a @i{Security Provider} to add to the current list of @i{Security Providers} already installed in the JVM in-use. If a provider class is specified with this option, and was successfully added to the runtime --i.e. it was not already installed-- then the tool will attempt to remove this @i{Security Provider} before exiting.
+A fully qualified class name of a @i{Security Provider} to add to the current list of @i{Security Providers} already installed in the JVM in-use. If a provider class is specified with this option, and was successfully added to the runtime --i.e.@: it was not already installed-- then the tool will attempt to remove this @i{Security Provider} before exiting.
 
 @item -help
 Prints a help text similar to this one.
@@ -390,7 +390,7 @@ The following options may be specified when using the tool for signing purposes.
 @item -keystore @var{URL}
 Use this option to specify the location of the key store to use. The default value is a file URL referencing the file named @file{.keystore} located in the path returned by the call to @code{java.lang.System#getProperty(String)} using @code{user.home} as argument.
 
-If a URL was specified, but was found to be malformed --e.g. missing protocol element-- the tool will attempt to use the URL value as a file-name (with absolute or relative path-name) of a key store --as if the protocol was @code{file:}.
+If a URL was specified, but was found to be malformed --e.g.@: missing protocol element-- the tool will attempt to use the URL value as a file-name (with absolute or relative path-name) of a key store --as if the protocol was @code{file:}.
 
 @item -storetype @var{STORE_TYPE}
 Use this option to specify the type of the key store to use. The default value, if this option is omitted, is that of the property @code{keystore.type} in the security properties file, which is obtained by invoking the static method call @code{getDefaultType()} in @code{java.security.KeyStore}.
@@ -404,12 +404,12 @@ Use this option to specify the password which the tool will use to unlock the @i
 If this option is omitted, the tool will first attempt to unlock the @i{Key Entry} using the same password protecting the key store. If this fails, you will then be prompted to provide a password.
 
 @item -sigfile @var{NAME}
-Use this option to designate a literal that will be used to construct file names for both the @code{.SF} and @code{.DSA} signature files. These files  will be generated, by the tool, and placed in the @file{META-INF} directory of the signed JAR.  Permissible characters for @var{NAME} must be in the range "a-zA-Z0-9_-".  All characters will be converted to upper-case ones.
+Use this option to designate a literal that will be used to construct file names for both the @code{.SF} and @code{.DSA} signature files. These files  will be generated, by the tool, and placed in the @file{META-INF} directory of the signed JAR@.  Permissible characters for @var{NAME} must be in the range "a-zA-Z0-9_-".  All characters will be converted to upper-case ones.
 
 If this option is missing, the first eight characters of the @var{ALIAS} argument will be used. When this is the case, any character in @var{ALIAS} that is outside the permissible range of characters will be replaced by an underscore.
 
 @item -signedjar @var{FILE}
-Use this option to specify the file name of the signed JAR. If this option is omitted, then the signed JAR will be named the same as @var{FILE}; i.e. the input JAR file will be replaced with the signed copy.
+Use this option to specify the file name of the signed JAR@. If this option is omitted, then the signed JAR will be named the same as @var{FILE}; i.e., the input JAR file will be replaced with the signed copy.
 
 @end table
 @c man end
@@ -449,7 +449,7 @@ keytool [@var{COMMAND}] @dots{}
 @c man begin DESCRIPTION gkeytool
 Cryptographic credentials, in a Java environment, are usually stored in a @i{Key Store}. The Java SDK specifies a @i{Key Store} as a persistent container of two types of objects: @i{Key Entries} and @i{Trusted Certificates}. The security tool @command{keytool} is a Java-based application for managing those types of objects.
 
-A @i{Key Entry} represents the private key part of a key-pair used in Public-Key Cryptography, and a signed X.509 certificate which authenticates the public key part for a known entity; i.e. the owner of the key-pair. The X.509 certificate itself contains the public key part of the key-pair.
+A @i{Key Entry} represents the private key part of a key-pair used in Public-Key Cryptography, and a signed X.509 certificate which authenticates the public key part for a known entity; i.e.@: the owner of the key-pair. The X.509 certificate itself contains the public key part of the key-pair.
 
 A @i{Trusted Certificate} is a signed X.509 certificate issued by a trusted entity. The @i{Trust} in this context is relative to the User of the @command{keytool}. In other words, the existence of a @i{Trusted Certificate} in the @i{Key Store} processed by a @command{keytool} command implies that the User trusts the @i{Issuer} of that @i{Trusted Certificate} to also sign, and hence authenticates, other @i{Subjects} the tool may process.
 
@@ -596,11 +596,11 @@ Use this option to specify the password protecting the key store. If this option
 @item -keystore @var{URL}
 Use this option to specify the location of the key store to use. The default value is a file URL referencing the file named @file{.keystore} located in the path returned by the call to @code{java.lang.System#getProperty(String)} using @code{user.home} as argument.
 
-If a URL was specified, but was found to be malformed --e.g. missing protocol element-- the tool will attempt to use the URL value as a file-name (with absolute or relative path-name) of a key store --as if the protocol was @code{file:}.
+If a URL was specified, but was found to be malformed --e.g.@: missing protocol element-- the tool will attempt to use the URL value as a file-name (with absolute or relative path-name) of a key store --as if the protocol was @code{file:}.
 
 @anchor{provider}
 @item -provider @var{PROVIDER_CLASS_NAME}
-A fully qualified class name of a @i{Security Provider} to add to the current list of @i{Security Providers} already installed in the JVM in-use. If a provider class is specified with this option, and was successfully added to the runtime --i.e. it was not already installed-- then the tool will attempt to removed this @i{Security Provider} before exiting.
+A fully qualified class name of a @i{Security Provider} to add to the current list of @i{Security Providers} already installed in the JVM in-use. If a provider class is specified with this option, and was successfully added to the runtime --i.e.@: it was not already installed-- then the tool will attempt to removed this @i{Security Provider} before exiting.
 
 @anchor{file}
 @item -file @var{FILE}
@@ -624,17 +624,17 @@ A @i{Distinguished Name} (or DN) MUST be supplied with some of the @code{COMMAND
 
 @ftable @var
 @item CN
-The Common Name; e.g. @kbd{host.domain.com}
+The Common Name; e.g.@: @kbd{host.domain.com}
 @item OU
-The Organizational Unit; e.g. @kbd{IT Department}
+The Organizational Unit; e.g.@: @kbd{IT Department}
 @item O
-The Organization Name; e.g. @kbd{The Sample Company}
+The Organization Name; e.g.@: @kbd{The Sample Company}
 @item L
-The Locality Name; e.g. @kbd{Sydney}
+The Locality Name; e.g.@: @kbd{Sydney}
 @item ST
-The State Name; e.g. @kbd{New South Wales}
+The State Name; e.g.@: @kbd{New South Wales}
 @item C
-The 2-letter Country identifier; e.g. @kbd{AU}
+The 2-letter Country identifier; e.g.@: @kbd{AU}
 @end ftable
 
 When specified with a @code{-dname} option, each pair of component/value will be separated from the other with a comma. Each component and value pair MUST be separated by an equal sign. For example, the following is a valid DN value:@*
@@ -683,10 +683,10 @@ For more details @pxref{keyalg,, ALGORITHM}.
 For more details @pxref{keysize,, KEY_SIZE}.
 
 @item -sigalg @var{ALGORITHM}
-The canonical name of the digital signature algorithm to use for signing certificates. If this option is omitted, a default value will be chosen based on the type of the key-pair; i.e. the algorithm that ends up being used by the -keyalg option. If the key-pair generation algorithm is @code{DSA}, the value for the signature algorithm will be @code{SHA1withDSA}. If on the other hand the key-pair generation algorithm is @code{RSA}, then the tool will use @code{MD5withRSA} as the signature algorithm.
+The canonical name of the digital signature algorithm to use for signing certificates. If this option is omitted, a default value will be chosen based on the type of the key-pair; i.e., the algorithm that ends up being used by the -keyalg option. If the key-pair generation algorithm is @code{DSA}, the value for the signature algorithm will be @code{SHA1withDSA}. If on the other hand the key-pair generation algorithm is @code{RSA}, then the tool will use @code{MD5withRSA} as the signature algorithm.
 
 @item -dname @var{NAME}
-This a mandatory value for the command. If no value is specified --i.e. the @option{-dname} option is omitted-- the tool will prompt you to enter a @i{Distinguished Name} to use as both the @i{Owner} and @i{Issuer} of the generated self-signed certificate.
+This a mandatory value for the command. If no value is specified --i.e.@: the @option{-dname} option is omitted-- the tool will prompt you to enter a @i{Distinguished Name} to use as both the @i{Owner} and @i{Issuer} of the generated self-signed certificate.
 
 For more details @pxref{dn,, X.500 DISTINGUISHED NAME}.
 
@@ -909,7 +909,7 @@ FC...IVwNVOfQLRX+O5kAhQ/a4RTZme2L8PnpvgRwrf7Eg8D6w==
 -----END NEW CERTIFICATE REQUEST-----
 @end example
 
-@b{IMPORTANT}: Some documentation (e.g. RSA examples) claims that the @code{Attributes} field, in the CSR is @code{OPTIONAL} while RFC-2986 implies the opposite. This implementation considers this field, by default, as @code{OPTIONAL}, unless the option @option{-attributes} is specified on the command line.
+@b{IMPORTANT}: Some documentation (e.g.@: RSA examples) claims that the @code{Attributes} field, in the CSR is @code{OPTIONAL} while RFC-2986 implies the opposite. This implementation considers this field, by default, as @code{OPTIONAL}, unless the option @option{-attributes} is specified on the command line.
 
 @table @gcctabopt
 @item -alias @var{ALIAS}
index 889784e..8381828 100644 (file)
@@ -281,7 +281,7 @@ which is responsible for the specified class.
 @item @code{forName(String, boolean, ClassLoader)} -- The VM should create a
 @code{Class} instance corresponding to the named class.  As noted in
 @ref{VM Hooks}, the internal content of the instance is the
-responsibility of the VM.  The supplied class loader is recorded as that
+responsibility of the VM@.  The supplied class loader is recorded as that
 which loaded the class, and the boolean specifies whether or not to
 run the class initializer.
 @item @code{isArray(Class)} -- Another property test, corresponding to a
@@ -393,7 +393,7 @@ supplied class.
 loader.
 @item @code{getPrimitiveClass(char)} -- The VM should provide a @code{Class}
 implementation for one of the primitive classes.  The supplied character
-matches the JNI code for the primitive class e.g. `B' for byte and
+matches the JNI code for the primitive class e.g.@: `B' for byte and
 `Z' for boolean.
 @end itemize
 @item Java Methods
@@ -485,7 +485,7 @@ making a VM implementation optional.
 @subsection @code{java.lang.VMThrowable}
 @code{VMThrowable} is used to hold the VM state of a throwable, created either
 when a @code{Throwable} is created or the @code{fillInStackTrace()} method is
-called (i.e. when the actual stack trace is needed, as a lot of exceptions are
+called (i.e., when the actual stack trace is needed, as a lot of exceptions are
 never actually used).  The actual class has two @code{native} methods,
 one (@code{fillInStackTrace()}) being a method of the class used to obtain
 instances, and the other an instance method, @code{getStackTrace()}.
@@ -633,7 +633,7 @@ running the finalization process at exit.
 returning an integer which is non-zero for success.  Nothing happens if the
 file has already been loaded.
 @item @code{mapLibraryName(String)} -- The VM should map the system-independent
-library name supplied to the platform-dependent equivalent (e.g. a @code{.so}
+library name supplied to the platform-dependent equivalent (e.g.@: a @code{.so}
 or @code{.dll} file)
 @end itemize
 
@@ -962,7 +962,7 @@ a directory.
 @itemize @bullet
 @item @code{canWriteDirectory(File)} -- Checks that the directory can be
 written to, by trying to create a temporary file in it.
-@item @code{listRoots()} -- Returns the root of a GNU filesystem i.e. `/'
+@item @code{listRoots()} -- Returns the root of a GNU filesystem, i.e.@: `/'
 in an array.
 @item @code{isHidden(String)} -- Checks whether the file starts with `.',
 which is how files are hidden on UNIX-style systems.
@@ -1247,7 +1247,7 @@ by a specific class loader.
 @end itemize
 
 Instrumentation allows to modify the bytecode of a class before it gets read
-by the VM. In GNU Classpath, the @code{ClassLoader.defineClass} method calls
+by the VM@. In GNU Classpath, the @code{ClassLoader.defineClass} method calls
 the @code{VMClassLoader.defineClassWithTransformers} method which first checks
 if @code{VMClassLoader.instrumenter} is @code{null}. If it's the case, it
 directly calls @code{VMClassLoader.defineClass}. If it's not the case, the
@@ -1257,11 +1257,11 @@ object and returns a new bytecode array. Then, it calls the
 @code{VMClassLoader.defineClass} method with this new bytecode array.
 
 The second use of instrumentation is to redefine a class after it has been
-loaded by the VM. This is done in the Java application by calling the
+loaded by the VM@. This is done in the Java application by calling the
 @code{Instrumentation.redefineClasses} method of the standard interface on
 a @code{Instrumentation} object. The @code{InstrumentationImpl.redefineClasses}
 method calls the @code{VMInstrumentationImpl.redefineClasses} native method
-which must be implemented by the VM. The implementation should call the
+which must be implemented by the VM@. The implementation should call the
 @code{InstrumentationImpl.callTransformers} method.
 
 @node gnu.java.lang.management, java.lang.management, gnu.java.lang, Classpath Hooks
@@ -1304,7 +1304,7 @@ arguments, excluding those that are directed at the
 this to be a native method.
 @item @code{(getName())} -- The VM developer should choose
 an appropriate name for the virtual machine.  This name can
-be instance-specific e.g. it can include things like the
+be instance-specific e.g.@: it can include things like the
 process identifier or host name of the machine, which only
 apply to the current running instance.  Thus, the intention is
 that this name refers to the entity that the other information
@@ -1611,7 +1611,7 @@ memory pools that the manager maintains.  A default implementation
 which scans the results of @code{getMemoryManagerNames()} for each
 pool is provided.
 @item @code{(isValid(String))} -- Returns true if the specified
-manager is still valid i.e. it is still in use by the virtual machine.
+manager is still valid, i.e., it is still in use by the virtual machine.
 @end itemize
 
 @node gnu.java.lang.management.VMGarbageCollectorMXBeanImpl,,gnu.java.lang.management.VMMemoryManagerMXBeanImpl,gnu.java.lang.management
@@ -1739,7 +1739,7 @@ The following issues are of note;
 The GNU Classpath implementation of @code{java.lang.Class} provides an
 object for storing the internal state of the class maintained by the VM.
 This is the only known place where this matters.  The class is
-constructed with this data by the VM.  Some VMs do not create the
+constructed with this data by the VM@.  Some VMs do not create the
 @code{Class} object at the point where the class is defined; instead,
 they wait until a @code{Class} object is actually used.
 
@@ -1920,7 +1920,7 @@ configured with its jthreads model.
 @item
 @i{Green threads 2}: The essential difference with this model is to
 not switch threads on an event, but at fixed points in the code being
-executed by the VM. Points chosen could be backward branches (loops)
+executed by the VM@. Points chosen could be backward branches (loops)
 or method calls. This approach can be advantageous to nonconservative
 garbage collectors, as non-running threads would be at known points
 and can have fixed register maps. It can also reduce the number of
@@ -1989,7 +1989,7 @@ must wait for the lock.
 As of GNU Classpath 0.15 a system property named @code{gnu.classpath.boot.library.path}
 can be set by the VM to specify the directories which contain GNU Classpath's native
 libraries. Usually this value is given at configuration time and is then hardcoded
-in the VM. However for development purposes it is handy to switch to another installation
+in the VM@. However for development purposes it is handy to switch to another installation
 by overriding the properties' value on the command line.
 
 A VM that does not support this feature can simply ignore the property.