squid
squid copied to clipboard
squid-cache
Documentation: Initial pandoc conversion
Add pandoc tools dependency to Squid.
Initial documentation file conversion to Markdown see https://github.github.com/gfm/ for syntax.
Also, updated and polished the squid.8 content to comply better with manual practices and Squid current features / behaviours.
I would support GFM as a dialect; it has powerful backing and should be strict enough that we wouldn't end up in the situation we had with the wiki. I expect that all that's needed to adopt it is to change the argument to pandoc, so no need to redo translation work.
@yadij , can you agree to this?
@kinkie, this is failing Jenkins due to lack of pandoc build dependency. Can that be fixed soonish?
Ouch. It can be done, but it will take a couple of days at best if we zip through QA for the new container images.
I'm on it
There's a snag: at least on some architectures, opensuse doesn't ship pandoc. Is there any way to make the build more resilient if it isn't found?
On Tue, Dec 19, 2023 at 11:40 AM Amos Jeffries @.***> wrote:
@kinkie https://github.com/kinkie, this is failing Jenkins due to lack of pandoc build dependency. Can that be fixed soonish?
— Reply to this email directly, view it on GitHub https://github.com/squid-cache/squid/pull/1586#issuecomment-1862520008, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABHPVDAEHTX66OYW7TDSMH3YKFVI7AVCNFSM6AAAAAA7M7J662VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNRSGUZDAMBQHA . You are receiving this because you were mentioned.Message ID: @.***>
-- Francesco
Great, thanks!
I'm working on upgrading most of the jenkins farm to support it.
The major holdout (at least for the time being) is gentoo
There is a snag: the pandoc version shipped with Ubuntu Bionic doesn't support GFM (see https://build.squid-cache.org/job/5-pr-test/COMPILER=gcc,OS=ubuntu-bionic,label=pr-test-builder/6721/console) .
Oh cool! I hadn’t noticed. Removing it everywhere
@mobile
On Thu, 21 Dec 2023 at 13:58, Amos Jeffries @.***> wrote:
Bionic passed its EOL April 2023. Can we remove it from v7 testing?
— Reply to this email directly, view it on GitHub https://github.com/squid-cache/squid/pull/1586#issuecomment-1866202193, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABHPVDDDAUM4JDQ4UMZPAGDYKQXABAVCNFSM6AAAAAA7M7J662VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNRWGIYDEMJZGM . You are receiving this because you were mentioned.Message ID: @.***>
Oh cool! I hadn’t noticed. Removing it everywhere
That removal may help work around "getPod() used for a POD" build failures in master/v7 as well. Those failures are currently blocking #1623 AFAICT.
Please do not forget to update Anubis staging_checks configuration if you are changing the number of Jenkins tests for staged commits. Please ping @eduard-bagdasaryan if you need help with that update.
Oh cool! I hadn’t noticed. Removing it everywhere
That removal may help work around "getPod() used for a POD" build failures in master/v7 as well. Those failures are currently blocking #1623 AFAICT.
I'm tweaking the opensuse leap image; the getPod() issue is probably caused by the default compiler being too old, I'm working around it by installing a recent gcc. There's more challenges I'll work on now.
Please do not forget to update Anubis
staging_checksconfiguration if you are changing the number of Jenkins tests for staged commits. Please ping @eduard-bagdasaryan if you need help with that update.
Yes. It should be okay now, but in case I will
Currently, the biggest missing/unknown piece of information for me here is whether gfm supports metadata blocks
gfm supports - in fact, requires to be practically used - metadata in the form of Front Matter
Reviewer insists that we select a final and permanent Markdown syntax up-front and only use that one syntax forever, in all places Squid can or may now or in future utilize Markdown.
Nobody insists on (or even suggests) that.
I'm working on upgrading most of the jenkins farm to support it.
The major holdout (at least for the time being) is gentoo
Let me know if I can help with anything on the Gentoo side (feel free to ping me on anything related in the future as well). Thanks!
