From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from out02.mta.xmission.com (out02.mta.xmission.com [166.70.13.232]) by mx.groups.io with SMTP id smtpd.web09.7305.1638932219873505912 for ; Tue, 07 Dec 2021 18:56:59 -0800 Authentication-Results: mx.groups.io; dkim=fail reason="no key for verify" header.i=@bsdio.com header.s=xmission header.b=jikbeg9/; spf=neutral (domain: bsdio.com, ip: 166.70.13.232, mailfrom: rebecca@bsdio.com) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=simple/simple; d=bsdio.com; s=xmission; h=Subject:Content-Transfer-Encoding:Content-Type:In-Reply-To: MIME-Version:Date:Message-ID:From:References:To:Sender:Reply-To:Cc:Content-ID :Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To: Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe :List-Post:List-Owner:List-Archive; bh=uoxUYP0t1ujmhYcpedTMaH+SHl2/h+mEv5Y1oJvFdYg=; b=jikbeg9/APVraMlC9tBLtNF5zB UIAisjDFnhWmfpuDql6JJTMPcrU7KKYrRGqLfbk86ezm9jh8EnLrLBKLAwjx/8uFvAF8FT9huHRI/ CHb1RxGmk0lJHZK96VfdhGBhjinAXFLuNRPwJii7cK/1EKLeTiIfFtgD2HlVQWYvzqSo=; Received: from in01.mta.xmission.com ([166.70.13.51]:37120) by out02.mta.xmission.com with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.93) (envelope-from ) id 1mun8b-00Ebb5-Fq; Tue, 07 Dec 2021 19:56:57 -0700 Received: from mta5.zcs.xmission.com ([166.70.13.69]:45946) by in01.mta.xmission.com with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.93) (envelope-from ) id 1mun8Y-004U65-Ts; Tue, 07 Dec 2021 19:56:56 -0700 Received: from localhost (localhost [127.0.0.1]) by mta5.zcs.xmission.com (Postfix) with ESMTP id A8D061280C86; Tue, 7 Dec 2021 19:56:54 -0700 (MST) X-Amavis-Modified: Mail body modified (using disclaimer) - mta5.zcs.xmission.com Received: from mta5.zcs.xmission.com ([127.0.0.1]) by localhost (mta5.zcs.xmission.com [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id QNCbFABqT4dx; Tue, 7 Dec 2021 19:56:54 -0700 (MST) Received: from [10.0.10.45] (c-98-202-153-46.hsd1.ut.comcast.net [98.202.153.46]) by mta5.zcs.xmission.com (Postfix) with ESMTPSA id 770691280C64; Tue, 7 Dec 2021 19:56:54 -0700 (MST) To: devel@edk2.groups.io, michael.d.kinney@intel.com References: <30cc16f7-0804-7e16-ba78-089b6d338449@bsdio.com> <6c97560c-ff39-5488-4ecf-8e0076c43a6d@bsdio.com> From: "Rebecca Cran" Message-ID: Date: Tue, 7 Dec 2021 19:56:54 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.13.0 MIME-Version: 1.0 In-Reply-To: X-XM-SPF: eid=1mun8Y-004U65-Ts;;;mid=;;;hst=in01.mta.xmission.com;;;ip=166.70.13.69;;;frm=rebecca@bsdio.com;;;spf=neutral X-SA-Exim-Connect-IP: 166.70.13.69 X-SA-Exim-Mail-From: rebecca@bsdio.com X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on sa02.xmission.com X-Spam-Level: X-Spam-Status: No, score=0.8 required=8.0 tests=ALL_TRUSTED,BAYES_50, DCC_CHECK_NEGATIVE,NICE_REPLY_A,TR_XM_BayesUnsub,T_TM2_M_HEADER_IN_MSG, TooManyTo_001,XMSubLong,XM_B_SpammyWords,XM_B_Unsub autolearn=disabled version=3.4.2 X-Spam-Virus: No X-Spam-Report: * -1.0 ALL_TRUSTED Passed through trusted hosts only via SMTP * 0.8 BAYES_50 BODY: Bayes spam probability is 40 to 60% * [score: 0.5000] * 0.3 TooManyTo_001 Multiple "To" Header Recipients 2x (uncommon) * 0.7 XMSubLong Long Subject * 0.0 T_TM2_M_HEADER_IN_MSG BODY: No description available. * -0.0 DCC_CHECK_NEGATIVE Not listed in DCC * [sa02 1397; IP=ok Body=1 Fuz1=1] [Fuz2=1] * 0.2 XM_B_SpammyWords One or more commonly used spammy words * 0.5 XM_B_Unsub Unsubscribe in body of email but missing unsubscribe * header * 1.5 TR_XM_BayesUnsub High bayes score with no unsubscribe header * -2.2 NICE_REPLY_A Looks like a legit reply (A) X-Spam-DCC: XMission; sa02 1397; IP=ok Body=1 Fuz1=1 Fuz2=1 X-Spam-Combo: ;devel@edk2.groups.io, michael.d.kinney@intel.com X-Spam-Relay-Country: X-Spam-Timing: total 1741 ms - load_scoreonly_sql: 0.04 (0.0%), signal_user_changed: 4.7 (0.3%), b_tie_ro: 3.3 (0.2%), parse: 1.68 (0.1%), extract_message_metadata: 29 (1.6%), get_uri_detail_list: 7 (0.4%), tests_pri_-1000: 29 (1.7%), tests_pri_-950: 1.05 (0.1%), tests_pri_-900: 0.81 (0.0%), tests_pri_-90: 68 (3.9%), check_bayes: 66 (3.8%), b_tokenize: 13 (0.8%), b_tok_get_all: 13 (0.8%), b_comp_prob: 4.2 (0.2%), b_tok_touch_all: 32 (1.8%), b_finish: 0.80 (0.0%), tests_pri_0: 1593 (91.5%), check_dkim_signature: 0.52 (0.0%), check_dkim_adsp: 68 (3.9%), poll_dns_idle: 67 (3.8%), tests_pri_10: 2.8 (0.2%), tests_pri_500: 10 (0.6%), rewrite_mail: 0.00 (0.0%) Subject: Re: [edk2-devel] EDK2 doxygen documentation - adding docs for stable tags? X-SA-Exim-Version: 4.2.1 (built Sat, 08 Feb 2020 21:53:50 +0000) X-SA-Exim-Scanned: Yes (on in01.mta.xmission.com) Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Content-Language: en-US I have a doxyfile at https://bsdio.com/edk2/docs/master.doxyfile which generates it. I run "doxygen ../master.doxyfile" from the root of an edk2 clone. -- Rebecca Cran On 12/5/21 12:09 AM, Michael D Kinney wrote: > Rebecca, > > I like that combined version. > > How did you package them together? > > Mike > >> -----Original Message----- >> From: devel@edk2.groups.io On Behalf Of Rebecca Cran >> Sent: Saturday, December 4, 2021 8:31 PM >> To: Kinney, Michael D ; devel@edk2.groups.io >> Subject: Re: [edk2-devel] EDK2 doxygen documentation - adding docs for stable tags? >> >> Thanks. Would it be possible to have all the packages together, like >> https://bsdio.com/edk2/docs/master/index.html (ignoring that the page >> has information about Dynamic AML Generation!)? >> >> >> I'm not sure if we need to include the cross-referenced source files >> like mine does, but it might be nice. >> >> >> -- >> Rebecca Cran >> >> >> On 12/4/21 21:01, Kinney, Michael D wrote: >>> Hi Rebecca, >>> >>> Here is a first pass at publishing all the package documents on GitHub Pages. >>> >>> https://mdkinney.github.io/edk2/index.html >>> >>> I have a GitHub Action that pulls the code from an edk2 repo for a specific >>> branch/tag/sha, installs doxygen, generates the HTML documentation for >>> all packages, and publishes the HTML content to a gh-pages branch. GitHub >>> deploys a new version of the web pages each time there is a push to the >>> gh-pages branch. >>> >>> I had to make a couple small fixes to PackageDocumentTools. I will enter >>> a BZ and get those reviewed. The branch with those fixes are here: >>> >>> https://github.com/mdkinney/edk2/tree/Bug_xxx_PackageDocumentationToolFixes >>> https://github.com/mdkinney/edk2/commit/e3eb394ea52621dc02e45d4f78f319cfeb0da68f >>> >>> The GitHub Action is located here: >>> >>> https://github.com/mdkinney/edk2/blob/sandbox/CompareBuild/.github/workflows/PackageDocumentationBuild.yml >>> >>> The deployments page is here. It is updates each time new content is pushed >>> to gh-pages branch. >>> >>> https://github.com/mdkinney/edk2/deployments/activity_log?environment=github-pages >>> >>> This first attempt pushes to a gh-pages branch in my personal fork of the edk2 repo. >>> Given the size of the HTML documentation, I would not recommend that this content be >>> stored in the same repo with the edk2 sources. I would recommend creating a new >>> repo in the tianocore-docs org that would host the GitHub action and can fetch a >>> branch/tag/sha from tianocore/edk2 to publish package documentation in the >>> tianocore-docs org repository. >>> >>> Please review the results and compare to your previous work to see if this is >>> an equivalent replacement. >>> >>> The GitBook documents that are also hosted in tianocore-docs org support publishing >>> multiple releases and a draft release of each document by adding a top level >>> directory to gh-pages. We could do the same for package documentation by >>> having a weekly publication of the draft based on latest tianocore/edk2/master. >>> And we could generate a released version of the package documentation >>> when a new stable-tag is added to tianocore/edk2. >>> >>> Thanks, >>> >>> Mike >>> >>>> -----Original Message----- >>>> From: Kinney, Michael D >>>> Sent: Wednesday, December 1, 2021 9:02 AM >>>> To: devel@edk2.groups.io; rebecca@bsdio.com; Kinney, Michael D >>>> Subject: RE: [edk2-devel] EDK2 doxygen documentation - adding docs for stable tags? >>>> >>>> Hi Rebecca, >>>> >>>> It does not push to gitbook server. It is pushed to web pages hosted by GitHub. >>>> >>>> It uses gitbook tools to process MD files into published PDF, MOBI, HTML. >>>> >>>> For example, the EDK II Build Specification has repo in GitHub: >>>> >>>> https://github.com/tianocore-docs/edk2-BuildSpecification >>>> >>>> And the HTML version of the draft revision of this spec is published here: >>>> >>>> https://tianocore-docs.github.io/edk2-BuildSpecification/draft/ >>>> >>>> These are the web pages associated with tianocore-docs org. >>>> >>>> Thanks, >>>> >>>> Mike >>>> >>>>> -----Original Message----- >>>>> From: devel@edk2.groups.io On Behalf Of Rebecca Cran >>>>> Sent: Wednesday, December 1, 2021 8:52 AM >>>>> To: Kinney, Michael D ; devel@edk2.groups.io >>>>> Subject: Re: [edk2-devel] EDK2 doxygen documentation - adding docs for stable tags? >>>>> >>>>> From what I can see, the tianocore-docs actions push to gitbooks, not >>>>> tianocore.org? >>>>> >>>>> I don't think gitbooks will work for the doxygen pages. >>>>> >>>>> >>>>> -- >>>>> >>>>> Rebecca Cran >>>>> >>>>> >>>>> On 11/30/21 20:21, Kinney, Michael D wrote: >>>>>> Hi Rebecca, >>>>>> >>>>>> This is a good idea. We use GitHub Actions to publish the EDK II Specifications >>>>>> to a web page hosted as part of the documents GitHub repo. >>>>>> >>>>>> I think we can do something similar for generating and publishing the doxygen >>>>>> generated web content for the edk2 packages. I think a manually triggered >>>>>> GitHub action in a repo in tianocore-docs organization might be a good place >>>>>> to do this so all document publication activities are under that same org. >>>>>> The GitHub action can take a branch or tag or sha of the edk2 repo as input >>>>>> to generate the doxygen documentation. >>>>>> >>>>>> Best regards, >>>>>> >>>>>> Mike >>>>>> >>>>>>> -----Original Message----- >>>>>>> From: devel@edk2.groups.io On Behalf Of Rebecca Cran >>>>>>> Sent: Tuesday, November 9, 2021 3:20 PM >>>>>>> To: devel@edk2.groups.io; discuss@edk2.groups.io >>>>>>> Subject: [edk2-devel] EDK2 doxygen documentation - adding docs for stable tags? >>>>>>> >>>>>>> I've been hosting the Doxygen documentation for EDK2 at >>>>>>> https://bsdio.com/edk2/docs for a few years now. I previously had >>>>>>> versions for master, UDK2015, UDK2017, UDK2018 etc. but since migrating >>>>>>> my web server dropped everything except master. >>>>>>> >>>>>>> >>>>>>> I was wondering if people are finding it useful, and if so whether >>>>>>> they'd like me to generate documentation for each stable tag too? >>>>>>> >>>>>>> >>>>>>> Personally, _I_ find the web-based version (as opposed to a >>>>>>> locally-generated version) useful for the search feature -- being able >>>>>>> to quickly find the documentation for a certain function. >>>>>>> >>>>>>> >>>>>>> -- >>>>>>> >>>>>>> Rebecca Cran >>>>>>> >>>>>>> >>>>>>> >>>>>>> >>>>>>> >>>>>>> >>>>> >>>>> >> >> >> > > > > >