#839 Fix asciidoctor warnings
Closed 7 months ago by tibbs. Opened 7 months ago by scfc.
scfc/packaging-committee escape-to-fix-asciidoctor-warnings  into  master

@@ -5,7 +5,7 @@ 

  

  == Registering the modules system-wide

  

- Any package in Fedora containing a PKCS#11 provider module, intended to be used outside this package, MUST be registered with link:http://p11-glue.freedesktop.org/[p11-kit]. For example, the link:https://github.com/OpenSC/OpenSC/wiki[OpenSC] module which supports most major hardware smart cards, will automatically drop a config file into the appropriate place and then its module will automatically appear in well-behaved software which is integrated with the platform and uses p11-kit properly. The appropriate place in Fedora can be obtained with `pkg-config p11-kit-1 --variable p11_module_configs` or `%{_datadir}/p11-kit/modules/`. The dropped file should have the `.module` suffix and should contain something similar to the contents below (which is the opensc example). 

+ Any package in Fedora containing a PKCS#11 provider module, intended to be used outside this package, MUST be registered with link:http://p11-glue.freedesktop.org/[p11-kit]. For example, the link:https://github.com/OpenSC/OpenSC/wiki[OpenSC] module which supports most major hardware smart cards, will automatically drop a config file into the appropriate place and then its module will automatically appear in well-behaved software which is integrated with the platform and uses p11-kit properly. The appropriate place in Fedora can be obtained with `pkg-config p11-kit-1 --variable p11_module_configs` or `+%{_datadir}/p11-kit/modules/+`. The dropped file should have the `.module` suffix and should contain something similar to the contents below (which is the opensc example).

  

   # This file describes how to load the opensc module

   # See: http://p11-glue.freedesktop.org/doc/p11-kit/config.html

@@ -16,7 +16,7 @@ 

   # 32-bit and 64-bit and make them parallel installable

   module: opensc-pkcs11.so

  

- The provider module, as mentioned in the example below should be installed at `%{_libdir}/pkcs11/`.

+ The provider module, as mentioned in the example below should be installed at `+%{_libdir}/pkcs11/+`.

  

  Once a module is registered the tokens/HSMs provided by it should be listed in the `p11tool` output using the following command:

  

@@ -27,7 +27,7 @@ 

  [#registered]

  == How applications take advantage of registered provider modules

  

- Packages which can potentially use PKCS#11 tokens SHOULD automatically use the tokens which are present in the system's p11-kit configuration, rather than needing to have a PKCS#11 provider explicitly specified. That can be done by applications using the p11-kit library to get the list of modules, or by applications defaulting to the p11-kit proxy module (`%{_libdir}/p11-kit-proxy.so`), if no PKCS#11 provider module was specified by the user. The proxy module, is a single module wrapping all available registered modules.

+ Packages which can potentially use PKCS#11 tokens SHOULD automatically use the tokens which are present in the system's p11-kit configuration, rather than needing to have a PKCS#11 provider explicitly specified. That can be done by applications using the p11-kit library to get the list of modules, or by applications defaulting to the p11-kit proxy module (`+%{_libdir}/p11-kit-proxy.so+`), if no PKCS#11 provider module was specified by the user. The proxy module, is a single module wrapping all available registered modules.

  

  [#specify-card]

  == How to specify a specific smart card/HSM

no initial comment

Use pluses to escape asciidoc. such as +%{macro}+

Just to clarify: You mean use pluses to escape asciidoc inside backticks? Elsewhere, using \{ is fine (as shown by git grep '%\\{')?

I meant inside backticks, but I'd use it anywhere.

rebased onto ce29564

7 months ago

It looks to me as if Igor basically did these exact changes in commit cf30cb9.

Pull-Request has been closed by tibbs

7 months ago
Metadata