Clarify that the textmarkdownwriter feature includes GitHub features

Markdown support in Qt has always been symmetrically including all the
features to the best of our ability: we can write all the same features
as we can read (including github extensions like tables and checkboxes),
except that we standardize the output (so it's not always identical to
what was read: headings always have hashes, not setext-style; code
fences and thematic breaks are regenerated, so we don't keep the same
style as the original; and so on), and we probably still have a few
bugs. And in fact QTextMarkdownWriter does not (yet) have logic to
restrict itself to CommonMark, even if it's requested by means of the
QTextDocument::MarkdownFeatures ctor argument. (Of course if
QTextMarkdownImporter reads a document with CommonMark-only restriction
applied, and then you rewrite the document with QTextMarkdownWriter,
presumably you would not have any GitHub features in the output.)
So the existing output from configure -list-features was misleading:

texthtmlparser ........... Kernel: Provides a parser for HTML.
textmarkdownreader ....... Kernel: Provides a Markdown (CommonMark and GitHub) reader
textmarkdownwriter ....... Kernel: Provides a Markdown (CommonMark) writer
textodfwriter ............ Kernel: Provides an ODF writer.

Amends e4079eca49adce16e31dac2a18d49d7a55817891

Change-Id: Ic2d9664388bbf17cef41ca0eaad600485a1bb7ec
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
(cherry picked from commit 3bcfd55cb3bc45c92345cc69b361030534ddb140)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Shawn Rutledge 2024-01-26 13:36:00 -07:00 committed by Qt Cherry-pick Bot
parent 0dbe271b9c
commit f643656e88

View File

@ -1012,7 +1012,7 @@ qt_feature("system-textmarkdownreader" PUBLIC
qt_feature("textmarkdownwriter" PUBLIC qt_feature("textmarkdownwriter" PUBLIC
SECTION "Kernel" SECTION "Kernel"
LABEL "MarkdownWriter" LABEL "MarkdownWriter"
PURPOSE "Provides a Markdown (CommonMark) writer" PURPOSE "Provides a Markdown (CommonMark and GitHub) writer"
) )
qt_feature("textodfwriter" PUBLIC qt_feature("textodfwriter" PUBLIC
SECTION "Kernel" SECTION "Kernel"