From patchwork Thu Feb 13 17:56:38 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 1237656 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org (client-ip=209.51.188.17; helo=lists.gnu.org; envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org; receiver=) Authentication-Results: ozlabs.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.a=rsa-sha256 header.s=google header.b=YIRE4jcK; dkim-atps=neutral Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 48JPd75wGXz9sP7 for ; Fri, 14 Feb 2020 05:08:11 +1100 (AEDT) Received: from localhost ([::1]:57336 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2IuH-00071t-Oa for incoming@patchwork.ozlabs.org; Thu, 13 Feb 2020 13:08:09 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34321) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijr-0000lh-9E for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:24 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijp-00035U-QI for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:23 -0500 Received: from mail-wr1-x42b.google.com ([2a00:1450:4864:20::42b]:41524) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijp-00030B-J8 for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:21 -0500 Received: by mail-wr1-x42b.google.com with SMTP id c9so7823149wrw.8 for ; Thu, 13 Feb 2020 09:57:20 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=nWSMAlzi0oMRfWAEf8TA2pk4lWoUJVNUT6Q1IhJAJTw=; b=YIRE4jcK+0fjtmEQLEKh2kjaNrFYZxoyMYdp0YERwobrCTt+GIEMZ/lvNAduuK+83e LxcTVAxN+wPUFxfYcM66Bsz360iKWx8IoTTHlPwHR0duhoiCqf7V25D4Aq9KEhJcO1bB kANvVgdKYSMxDv7G0CTD8C+EIbIAmcjlstf+yfCM4vXH9IewdXkI8cSOb18yCSX35Okk iNI04V/y5VhKLs1wj68gPOIyf/R28wZpFJkHIsXSq2diosuFLNQPHyOFphowKsdcTU1Q xPuEP5Z35qQDwE8906fh0WJYTY0yTaOroSckfg+iYaRIQH4plPr0CNUZRBKOyA5xHR/O dIaA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=nWSMAlzi0oMRfWAEf8TA2pk4lWoUJVNUT6Q1IhJAJTw=; b=DqkhTT2bcviYm0T8G0zsNHYlZJFZsUcGPrFvUe1Cjqky2kCug62DuuI5NsIKeM4XAS mCIxlJFWdMirnToidViMoL3KLYzDB9DTfve8UujySEPcXJCXpvHR1u5mkE2ugDgEOukI zS7HfwhYOXQWy7LBnREzs9Gz7vlohYG4Eyap4Pt4XuJQWrmX211VidBWOzRDsgU9+XKl t4RUrfp6cr3oQ4k8U8UAwbufDZrJ/ejQd8PmNEV2AgOgosr1t7gDZ67prxoD2DQlugmu i5ewdz6RagAJQTp4kY9E6FmeutLs6uKsio/Lxs8B+6nfEP0ATVXcw+O4TEkIwRNlsVQ5 EuBQ== X-Gm-Message-State: APjAAAUp3T9/lCmcy0VZfn94ebvDNp2wBCAutj0rjmE7VCT9rEQwa9Y2 dxSUCoKmqwFIjANZbn94jeOgSIpLTa0= X-Google-Smtp-Source: APXvYqy96OB83DLNVXKqm6ESXGIib2d6iQEIwmAr+OrkP87HW2kY5ROT5F7gOvE7QX589jiuc1dKhg== X-Received: by 2002:adf:b60f:: with SMTP id f15mr23945099wre.372.1581616639294; Thu, 13 Feb 2020 09:57:19 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:18 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 21/30] tests/qapi/doc-good.json: Clean up markup Date: Thu, 13 Feb 2020 17:56:38 +0000 Message-Id: <20200213175647.17628-22-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::42b X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: "Qemu-devel" doc-good.json tests some oddities of markup that we don't want to accept. Make them match the more restrictive rST syntax: * in a single list the bullet types must all match * lists must have leading and following blank lines * indentation is important * the '|' example syntax is going to go away entirely, so stop testing it This will avoid the tests spuriously breaking when we tighten up the parser code in the following commits. Signed-off-by: Peter Maydell --- New patch in v2 --- tests/qapi-schema/doc-good.json | 25 +++++++++++++------------ tests/qapi-schema/doc-good.out | 12 ++++++------ tests/qapi-schema/doc-good.texi | 12 +++--------- 3 files changed, 22 insertions(+), 27 deletions(-) diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json index d992e713d97..a45dc22848c 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -10,25 +10,25 @@ # # *strong* _with emphasis_ # @var {in braces} +# # * List item one -# - Two, multiple +# * Two, multiple # lines # -# 3. Three -# Still in list +# * Three +# Still in list +# +# Not in list # -# Not in list # - Second list -# Note: still in list +# Note: still in list # # Note: not in list +# # 1. Third list # is numbered # -# - another item -# -# | example -# | multiple lines +# 2. another item # # Returns: the King # Since: the first age @@ -62,7 +62,7 @@ ## # @Base: # @base1: -# the first member +# the first member ## { 'struct': 'Base', 'data': { 'base1': 'Enum' } } @@ -101,7 +101,7 @@ ## # @Alternate: # @i: an integer -# @b is undocumented +# @b is undocumented ## { 'alternate': 'Alternate', 'data': { 'i': 'int', 'b': 'bool' } } @@ -115,7 +115,7 @@ # @arg1: the first argument # # @arg2: the second -# argument +# argument # # Features: # @cmd-feat1: a feature @@ -124,6 +124,7 @@ # Returns: @Object # TODO: frobnicate # Notes: +# # - Lorem ipsum dolor sit amet # - Ut enim ad minim veniam # diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index 4c9406a464d..9503a3a3178 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -68,25 +68,25 @@ doc freeform *strong* _with emphasis_ @var {in braces} + * List item one -- Two, multiple +* Two, multiple lines -3. Three +* Three Still in list Not in list + - Second list Note: still in list Note: not in list + 1. Third list is numbered -- another item - -| example -| multiple lines +2. another item Returns: the King Since: the first age diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi index d4b15dabf03..1e8063c8579 100644 --- a/tests/qapi-schema/doc-good.texi +++ b/tests/qapi-schema/doc-good.texi @@ -6,6 +6,7 @@ @strong{strong} @emph{with emphasis} @code{var} @{in braces@} + @itemize @bullet @item List item one @@ -20,6 +21,7 @@ Still in list @end itemize Not in list + @itemize @minus @item Second list @@ -28,6 +30,7 @@ Note: still in list @end itemize Note: not in list + @enumerate @item Third list @@ -36,15 +39,6 @@ is numbered @item another item -@example -example -@end example - -@example -multiple lines -@end example - - @end enumerate Returns: the King