From patchwork Mon Dec 9 01:14:34 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Oliver O'Halloran X-Patchwork-Id: 1205828 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 47WQJb606Fz9sNH for ; Mon, 9 Dec 2019 12:16:47 +1100 (AEDT) Authentication-Results: ozlabs.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="j9zEbBj6"; dkim-atps=neutral Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 47WQJb4jCRzDqLr for ; Mon, 9 Dec 2019 12:16:47 +1100 (AEDT) X-Original-To: skiboot@lists.ozlabs.org Delivered-To: skiboot@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=gmail.com (client-ip=2607:f8b0:4864:20::541; helo=mail-pg1-x541.google.com; envelope-from=oohall@gmail.com; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: lists.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="j9zEbBj6"; dkim-atps=neutral Received: from mail-pg1-x541.google.com (mail-pg1-x541.google.com [IPv6:2607:f8b0:4864:20::541]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 47WQGk2HKszDqLb for ; Mon, 9 Dec 2019 12:15:10 +1100 (AEDT) Received: by mail-pg1-x541.google.com with SMTP id b9so5853373pgk.12 for ; Sun, 08 Dec 2019 17:15:10 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=xCTA22tZ7JSvnY5rX86EXaazpG8lgy1pYgnJOB03uFo=; b=j9zEbBj6up7n4urONAWqNb7KOhxHaEbnclSkibfRUa6xgB7nTIRD51lh18bOWjNaBI rbOWttb69kntl7CLMWvVYCUGj/2ZSyO4rrtfUHECWDTOln4jUHuJb8uqmmMSTHqDp9i1 G/m6o9OrnzsvAJvMbpc519JkWMYeukczCKh82nrLxcWuN6en0JVe0fJfsyvYWHqKKP9d MAI9p5Tr+xo6uLumKPbxZy+Rjzpk3ioc8s+s3DBNdVThIJ3XReu/8MxW1X3H5dYKmo9h +2C+jTvfJfKXUQ56PKYlGT+ZzDYogC2ZKvku+OuNMKmUbdNfxtiWafYX3WkdsPFguIPF Vy3w== 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=xCTA22tZ7JSvnY5rX86EXaazpG8lgy1pYgnJOB03uFo=; b=ByDswUnaCsHFr9juy0oH8TRIOIa168UzP+JkdHsd4JwA3xxvH/4DIq5kNeueA2X3Sp SFaqUHXuppctQIInuJuaqklZB+MTrGzEkRtxvGvP01l0bSxBEHYdIOpRCvHXPmN5GR4y RV35dZ+Cojlaf2qqzN6lDqgug/+wE7DJqo4PGRY2axIUta9T8wkXEOQ2gPrUf9l+hdNv hSNd3oDOxwtQu+eUTatTF3OFcqKpqvUqBQUzxcBk9ZiiZ09FVl6rE+o049XoP3dhQAxK J6TRAB7SVJ86FRzYc6NcQSRxPZqZUURUO+lKmv1pehcJEPnL0uehIdOMbu/ePPyo2USH aEnQ== X-Gm-Message-State: APjAAAWmJvj7WRi/9p5qAp8ZIxUiq+TQQrDombdXCIMhMNYRvb2ahV1z P/LciKe5C7K0jVTbdFNCYXOVZCf9 X-Google-Smtp-Source: APXvYqwMW5Yv3SmtKzZYoMA/hVzOHiBGQqgVRb7ucx5e0edgCVzhOl7k1jwSx+FFcuV/2a/UcK/GlQ== X-Received: by 2002:a63:483:: with SMTP id 125mr15931669pge.217.1575854107327; Sun, 08 Dec 2019 17:15:07 -0800 (PST) Received: from wafer.ozlabs.ibm.com ([122.99.82.10]) by smtp.gmail.com with ESMTPSA id p68sm25529560pfp.149.2019.12.08.17.15.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 08 Dec 2019 17:15:06 -0800 (PST) From: Oliver O'Halloran To: skiboot@lists.ozlabs.org Date: Mon, 9 Dec 2019 12:14:34 +1100 Message-Id: <20191209011448.19319-4-oohall@gmail.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20191209011448.19319-1-oohall@gmail.com> References: <20191209011448.19319-1-oohall@gmail.com> MIME-Version: 1.0 Subject: [Skiboot] [PATCH 04/18] doc/secvar: Fix indentation warnings X-BeenThere: skiboot@lists.ozlabs.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Mailing list for skiboot development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: skiboot-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "Skiboot" Sphinx complains about the following line not being indented to the same starting point as the lines above. Signed-off-by: Oliver O'Halloran --- doc/opal-api/opal-secvar.rst | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/doc/opal-api/opal-secvar.rst b/doc/opal-api/opal-secvar.rst index f07c570a8ec7..3bb130e5df87 100644 --- a/doc/opal-api/opal-secvar.rst +++ b/doc/opal-api/opal-secvar.rst @@ -37,19 +37,19 @@ Parameters ``key`` a buffer used to associate with the variable data. May -be any encoding, but must not be all zeroes + be any encoding, but must not be all zeroes ``key_len`` size of the key buffer in bytes ``data`` return buffer to store the data blob of the requested variable if -a match was found. May be set to NULL to only query the size into -``data_size`` + a match was found. May be set to NULL to only query the size into + ``data_size`` ``data_size`` reference to the size of the ``data`` buffer. OPAL sets this to -the size of the requested variable if found. + the size of the requested variable if found. Return Values @@ -57,7 +57,7 @@ Return Values ``OPAL_SUCCESS`` the requested data blob was copied successfully. ``data`` was NULL, -and the ``data_size`` value was set successfully + and the ``data_size`` value was set successfully ``OPAL_PARAMETER`` ``key`` is NULL. @@ -69,7 +69,7 @@ and the ``data_size`` value was set successfully ``OPAL_PARTIAL`` the buffer size provided in ``data_size`` was insufficient. -``data_size`` is set to the minimum required size. + ``data_size`` is set to the minimum required size. ``OPAL_UNSUPPORTED`` secure variables are not supported by the platform @@ -97,16 +97,16 @@ Parameters ``key`` name of the previous variable or empty. The key of the next -variable in sequence will be copied to ``key``. If passed as empty, -returns the first variable in the bank + variable in sequence will be copied to ``key``. If passed as empty, + returns the first variable in the bank ``key_len`` length in bytes of the key in the ``key`` buffer. OPAL sets -this to the length in bytes of the next variable in sequence + this to the length in bytes of the next variable in sequence ``key_buf_size`` maximum size of the ``key`` buffer. The next key will not be -copied if this value is less than the length of the next key + copied if this value is less than the length of the next key Return Values @@ -114,21 +114,21 @@ Return Values ``OPAL_SUCCESS`` the key and length of the next variable in sequence was copied -successfully + successfully ``OPAL_PARAMETER`` ``key`` or ``key_length`` is NULL. ``key_size`` is zero. ``key_length`` is impossibly large. No variable with the associated -``key`` was found + ``key`` was found ``OPAL_EMPTY`` end of list reached ``OPAL_PARTIAL`` the size specified in ``key_size`` is insufficient for the next -variable's key length. ``key_length`` is set to the next variable's -length, but ``key`` is untouched + variable's key length. ``key_length`` is set to the next variable's + length, but ``key`` is untouched ``OPAL_UNSUPPORTED`` secure variables are not supported by the platform @@ -156,7 +156,7 @@ Parameters ``key`` a buffer used to associate with the variable data. May -be any encoding, but must not be all zeroes + be any encoding, but must not be all zeroes ``key_len`` size of the key buffer in bytes