From patchwork Mon Jan 13 22:12:27 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Julien Grall X-Patchwork-Id: 11331015 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id DBB4B6C1 for ; Mon, 13 Jan 2020 22:13:50 +0000 (UTC) Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id C11B22072B for ; Mon, 13 Jan 2020 22:13:50 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org C11B22072B Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=xen.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=xen-devel-bounces@lists.xenproject.org Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.89) (envelope-from ) id 1ir7x1-00024m-S7; Mon, 13 Jan 2020 22:12:47 +0000 Received: from all-amaz-eas1.inumbo.com ([34.197.232.57] helo=us1-amaz-eas2.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.89) (envelope-from ) id 1ir7x0-00024h-Jr for xen-devel@lists.xenproject.org; Mon, 13 Jan 2020 22:12:46 +0000 X-Inumbo-ID: d35d9ea8-3651-11ea-82f0-12813bfff9fa Received: from mail-wm1-f47.google.com (unknown [209.85.128.47]) by us1-amaz-eas2.inumbo.com (Halon) with ESMTPS id d35d9ea8-3651-11ea-82f0-12813bfff9fa; Mon, 13 Jan 2020 22:12:45 +0000 (UTC) Received: by mail-wm1-f47.google.com with SMTP id f129so11512370wmf.2 for ; Mon, 13 Jan 2020 14:12:45 -0800 (PST) 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; bh=pJTXjzMxIe8ST33LriGClk4UKgp3ybPvjw+mDaw6PXs=; b=fkgdQipAFBjFCXwd4JlBHDDxqK+LUyBEWjkdElXOnv2+pgxSy9ShhEuWOVObVcb2yk 6nHiknKvbHsCX58+gYsbIquD1heB/YqQ9Zq8p8JUzT5SP0tRBzzo7VlUBx05w2x9tVI6 YCz3MW23LAduZPQre+jyG9wWbozIS8VqG/zu8uoVQqEUdmiRa4Ek73hnEZ0PNwyIlVBm 5HDIU93Cj6GzrZibqPnI5KOOjWdF+E8LjNEVUfxLFC+fW4z+/HioAEuQkt0IVOcy4rCq H+E3AypjRHKG7xlYHBji20L5yFg0H1TlZWQMvZVzQP12rQGGH7xJp8GegbEb1H3gE2hF NRtQ== X-Gm-Message-State: APjAAAWOKRnk1F66DXr/q9tcp1P+LtlO9y9A6ljUFy+A0rDbL2qL1pha QigvXM0T17UeeQvVWGSjGaPGDuEge/roxA== X-Google-Smtp-Source: APXvYqxY8n1p/u89pJPQXmWKXKmU9F+iQMZKo5F/bcDBkdLDYtsGDamEPBPkOXNjL0btkQH8UXHmZQ== X-Received: by 2002:a1c:6404:: with SMTP id y4mr22821313wmb.143.1578953564990; Mon, 13 Jan 2020 14:12:44 -0800 (PST) Received: from ufe34d9ed68d054.ant.amazon.com (54-240-197-235.amazon.com. [54.240.197.235]) by smtp.gmail.com with ESMTPSA id j12sm18384785wrw.54.2020.01.13.14.12.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 13 Jan 2020 14:12:44 -0800 (PST) From: Julien Grall To: xen-devel@lists.xenproject.org Date: Mon, 13 Jan 2020 22:12:27 +0000 Message-Id: <20200113221227.20857-1-julien@xen.org> X-Mailer: git-send-email 2.17.1 Subject: [Xen-devel] [PATCH] docs/misc: livepatch: Espace backslash X-BeenThere: xen-devel@lists.xenproject.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Cc: Ross Lagerwall , Pawel Wieczorkiewicz , Julien Grall , Konrad Rzeszutek Wilk MIME-Version: 1.0 Errors-To: xen-devel-bounces@lists.xenproject.org Sender: "Xen-devel" pandoc is currently failing to generate the pdf with the following error: ! Undefined control sequence. l.1048 metadata string format is: key=value\0 In this case, we want to print \0 so we need to backslash-escape the first character. Interestingly pandoc will not complain when creating html and will just ignore \0 completely. Fixes: 5083e0ff93 ("livepatch: Add metadata runtime retrieval mechanism") Signed-off-by: Julien Grall Cc: Pawel Wieczorkiewicz Reviewed-by: Pawel Wieczorkiewicz Reviewed-by: Ross Lagerwall --- docs/misc/livepatch.pandoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/misc/livepatch.pandoc b/docs/misc/livepatch.pandoc index 2f3f95ed37..9473ad5991 100644 --- a/docs/misc/livepatch.pandoc +++ b/docs/misc/livepatch.pandoc @@ -739,7 +739,7 @@ The caller provides: Caller *MUST* allocate enough space to be able to store all received data (i.e. total allocated space *MUST* match the `metadata_total_size` value provided by the hypervisor). Individual payload metadata string can be of - arbitrary length. The metadata string format is: key=value\0...key=value\0. + arbitrary length. The metadata string format is: key=value\\0...key=value\\0. * `metadata_len` - Virtual address of where to write the length of each metadata string of the payload. Caller *MUST* allocate up to `nr` of them. Each *MUST* be of sizeof(uint32_t) (4 bytes).