Re: [PATCH 0/2] secilc/docs: add syntax highlighting for cil examples

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, Feb 4, 2021 at 12:10 PM bauen1 <j2468h@xxxxxxxxxxxxxx> wrote:
>
> Hi,
>
> To make editing the secilc docs easier, I've modified it to use fenced code blocks around all cil examples.
> This way editor syntax highlighting can do a better job and as a result I've found 3 minor bracket issues that are also fixed in patch 1.
>
> To allow pandoc to also do syntax highlighting I've written a rudimentary syntax definition in the format consumed by pandoc (https://docs.kde.org/trunk5/en/applications/katepart/highlight.html#katehighlight-xml-format) and enabled it.
> However pandocs default themes aren't the best, some of them don't highlight every keyword I've added, color scheme doesn't fit, etc ...
> On the other side It's very hard to just find 6 colors that work well together.
>
> I've uploaded an example using the default pandoc theme:
> https://glados.bauen1.xyz/misc_stuff_might_disappear/CIL_Reference_Guide.html
> https://glados.bauen1.xyz/misc_stuff_might_disappear/CIL_Reference_Guide.pdf
>

I notice on page 10:
(block unconfined
    (user user)
   ...

That the second user (which is the name of the user) is highlighted as
well as the user keyword.

Similar thing happens further done on page 10 with the rule:
(portcon udp 12345 (unconfined.user object_r unconfined.object ((s0) (s0(c0)))))

The "user" part of "unconfined.user" is highlighted.

"unconfined.user" is used in other examples as well.

Changing the first statement to be (user user1) would be fine, but I
would like "unconfined.user" to remain as is.
I am not sure how hard it would be to fix that.

I am not sure if this matters to anyone, but if the document is
printed, the syntax highlighting (particularly for the comments) might
make it a little bit hard to read.

Thanks,
Jim

> bauen1 (2):
>   secilc/docs: use fenced code blocks for cil examples
>   secilc/docs: add syntax highlighting for secil
>
>  secilc/docs/Makefile                          |  12 +-
>  secilc/docs/cil_access_vector_rules.md        |  33 ++-
>  secilc/docs/cil_call_macro_statements.md      |  10 +
>  .../cil_class_and_permission_statements.md    |  42 ++++
>  secilc/docs/cil_conditional_statements.md     |  16 +-
>  secilc/docs/cil_constraint_statements.md      |  16 ++
>  secilc/docs/cil_container_statements.md       |  16 ++
>  secilc/docs/cil_context_statement.md          |  10 +
>  secilc/docs/cil_file_labeling_statements.md   |  14 ++
>  secilc/docs/cil_infiniband_statements.md      |   9 +-
>  secilc/docs/cil_mls_labeling_statements.md    |  50 +++-
>  .../docs/cil_network_labeling_statements.md   |  16 ++
>  secilc/docs/cil_policy_config_statements.md   |  12 +
>  secilc/docs/cil_reference_guide.md            |  27 +++
>  secilc/docs/cil_role_statements.md            |  26 ++
>  secilc/docs/cil_sid_statements.md             |  12 +
>  secilc/docs/cil_type_statements.md            |  50 ++++
>  secilc/docs/cil_user_statements.md            |  42 +++-
>  secilc/docs/cil_xen_statements.md             |  20 ++
>  secilc/docs/secil.xml                         | 224 ++++++++++++++++++
>  20 files changed, 644 insertions(+), 13 deletions(-)
>  create mode 100644 secilc/docs/secil.xml
>
> --
> 2.30.0
>



[Index of Archives]     [Selinux Refpolicy]     [Linux SGX]     [Fedora Users]     [Fedora Desktop]     [Yosemite Photos]     [Yosemite Camping]     [Yosemite Campsites]     [KDE Users]     [Gnome Users]

  Powered by Linux