From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 566ACC433E6 for ; Mon, 8 Feb 2021 19:47:39 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 16AEE64E25 for ; Mon, 8 Feb 2021 19:47:39 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234920AbhBHTrf (ORCPT ); Mon, 8 Feb 2021 14:47:35 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54850 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S236454AbhBHTr0 (ORCPT ); Mon, 8 Feb 2021 14:47:26 -0500 Received: from mail-oi1-x235.google.com (mail-oi1-x235.google.com [IPv6:2607:f8b0:4864:20::235]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D94F4C061786 for ; Mon, 8 Feb 2021 11:46:39 -0800 (PST) Received: by mail-oi1-x235.google.com with SMTP id r75so3266692oie.11 for ; Mon, 08 Feb 2021 11:46:39 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=EN3GUn0G+as/kVN2AKBmb8Gvg1vPaJ4dbCT7NtDAVB8=; b=ZHWs6pg/+BWJAMkNSZCEW1ZtlWhXG+7SM5p+If40g0uyXLrcPSt5Zi6Ncc9p6Q7tLk QYbSyv7uMIAXJ/XdnC3FYTa2jbLTq5Tm+VResfM5g1O69Wg/01QVUIozwdFqCkuFlXF5 kkZWruwqxcj89HtXYFm1Pnlsy+pH8a5XjZppF5T6HyXB4vubvIG+yuZUBFMnL18GLxMQ Cd29qTRw/jU0ZReC8l8c9PiaTH8GI/VjjKFM8XioeJth27DVM6sxLec+8ctpmPRh7fjv KMn/VUl1zloAe8fdB16EbA4xxofdcHLzSo7DWHElG8NFA6D7DWor/F+1YRRXdZ76cjXo gJSg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=EN3GUn0G+as/kVN2AKBmb8Gvg1vPaJ4dbCT7NtDAVB8=; b=FVbwA91vv+rs0mpgnOHOYPaSN2pTtIzH5LguCLYylcG1YOH5PglZb0YFiN7DeQi+Tc ZBjmnhpU83dpSQe10eWVFKE1dzskbJp1qmbsU2XSeUjm4i837VtyoLtsYBC9C5CTPUdj uGycFU8VHOkCkvFG9alUbbRFVbd2nJr1948XuOFf+vaIMcW3MXcEqVLaOqF392FRq3uL fAodAZMcmaRTtc8IDW5FVeVKHvCA98p9HsYuFIwkOm4zEoiFFgxuM/X4dwEIzKCWlTRI 06CRwKPPUWFgEz9WTTd9t/J4jsQrQlSDJv7EWCeJnZN6c1E20War6pqP+BbaMu5CxPV0 nuLQ== X-Gm-Message-State: AOAM532/yvjnVfmor3pR8Ag8ZNCngW3edgVuJIn6/3X94S7dvf87RhXE eScgcGjWFn/EYY8Gqm8vbk5q6deDccGg9Bph/4WLZytMlzh2IA== X-Google-Smtp-Source: ABdhPJz4F9PYoVDkY68uzPTlHGwHDy0ZVAGpWbHlXy1GNlKyjJapmDslaYv1FishCP3C8ahEeZCa4qGLc4bF80pm2N8= X-Received: by 2002:aca:59d6:: with SMTP id n205mr244214oib.138.1612813599371; Mon, 08 Feb 2021 11:46:39 -0800 (PST) MIME-Version: 1.0 References: <90473e07-fe79-18d8-4772-52deb4f8e1bd@gmail.com> In-Reply-To: <90473e07-fe79-18d8-4772-52deb4f8e1bd@gmail.com> From: James Carter Date: Mon, 8 Feb 2021 14:46:28 -0500 Message-ID: Subject: Re: [PATCH v2 2/3] secilc/docs: add syntax highlighting for secil To: bauen1 Cc: SElinux list Content-Type: text/plain; charset="UTF-8" Precedence: bulk List-ID: X-Mailing-List: selinux@vger.kernel.org On Sat, Feb 6, 2021 at 4:05 PM bauen1 wrote: > > This is done by creating a somewhat rudimentary KDE syntax xml for > pandoc. > > The default styles provided by pandoc don't look very good and don't > highlight e.g. the strings marked as builtin. > > Signed-off-by: Jonathan Hettwer Acked-by: James Carter > --- > secilc/docs/Makefile | 10 +- > secilc/docs/secil.xml | 236 ++++++++++++++++++++++++++++++++++++++++++ > 2 files changed, 242 insertions(+), 4 deletions(-) > create mode 100644 secilc/docs/secil.xml > > diff --git a/secilc/docs/Makefile b/secilc/docs/Makefile > index 79a165ba..a91bcde0 100644 > --- a/secilc/docs/Makefile > +++ b/secilc/docs/Makefile > @@ -28,6 +28,8 @@ FILE_LIST ?= cil_introduction.md \ > > PANDOC_FILE_LIST = $(addprefix $(TMPDIR)/,$(FILE_LIST)) > > +PANDOC_HIGHLIGHT_STYLE="pygments" > + > PDF_OUT=CIL_Reference_Guide.pdf > HTML_OUT=CIL_Reference_Guide.html > PANDOC = pandoc > @@ -54,13 +56,13 @@ $(TMPDIR)/policy.cil: $(TESTDIR)/policy.cil > $(SED) -i '1i Example Policy\n=========\n```secil' $@ > echo '```' >> $@ > > -html: $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil > +html: $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil secil.xml > mkdir -p $(HTMLDIR) > - $(PANDOC) -t html $^ -o $(HTMLDIR)/$(HTML_OUT) > + $(PANDOC) --highlight-style=$(PANDOC_HIGHLIGHT_STYLE) --syntax-definition=secil.xml --standalone --metadata title="CIL Reference Guide" -t html $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil -o $(HTMLDIR)/$(HTML_OUT) > > -pdf: $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil > +pdf: $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil secil.xml > mkdir -p $(PDFDIR) > - $(PANDOC) --standalone --toc $^ -o $(PDFDIR)/$(PDF_OUT) > + $(PANDOC) --highlight-style=$(PANDOC_HIGHLIGHT_STYLE) --syntax-definition=secil.xml --standalone --toc $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil -o $(PDFDIR)/$(PDF_OUT) > > clean: > rm -rf $(HTMLDIR) > diff --git a/secilc/docs/secil.xml b/secilc/docs/secil.xml > new file mode 100644 > index 00000000..daa80ded > --- /dev/null > +++ b/secilc/docs/secil.xml > @@ -0,0 +1,236 @@ > + > + > + > + > + > + > + allow > + allowx > + auditallow > + auditallowx > + block > + blockabstract > + boolean > + booleanif > + category > + categoryalias > + categoryaliasactual > + categoryorder > + categoryset > + class > + classcommon > + classmap > + classmapping > + classorder > + classpermission > + classpermissionset > + common > + constrain > + context > + defaultrange > + defaultrole > + defaulttype > + defaultuser > + devicetreecon > + dontaudit > + dontauditx > + expandtypeattribute > + false > + filecon > + fsuse > + genfscon > + handleunknown > + ibendportcon > + ibpkeycon > + ioctl > + iomemcon > + ioportcon > + ipaddr > + level > + levelrange > + mls > + mlsconstrain > + mlsvalidatetrans > + netifcon > + neverallow > + neverallowx > + nodecon > + optional > + pcidevicecon > + perm > + permissionx > + pirqcon > + policycap > + portcon > + rangetransition > + role > + roleallow > + roleattribute > + roleattributeset > + rolebounds > + roletransition > + roletype > + selinuxuser > + selinuxuserdefault > + sensitivity > + sensitivityalias > + sensitivityaliasactual > + sensitivitycategory > + sensitivityorder > + sid > + sidcontext > + sidorder > + true > + tunable > + tunableif > + type > + typealias > + typealiasactual > + typeattribute > + typeattributeset > + typebounds > + typechange > + typemember > + typepermissive > + typetransition > + unordered > + user > + userattribute > + userattributeset > + userbounds > + userlevel > + userprefix > + userrange > + userrole > + validatetrans > + > + > + > + blockinherit > + call > + in > + macro > + > + > + > + and > + dom > + domby > + eq > + incomp > + neq > + not > + or > + range > + xor > + > + > + > + > + * > + all > + dccp > + false > + h1 > + h2 > + l1 > + l2 > + object_r > + r1 > + r2 > + r3 > + sctp > + self > + t1 > + t2 > + t3 > + tcp > + true > + u1 > + u2 > + u3 > + udp > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > -- > 2.30.0 >