public-mirrors/linux
1
0
Fork 0
mirror of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2025-09-18 22:14:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: dt: convert changesets to ReST

Browse source 
- Add a SPDX header;
- Add a document title;
- Some whitespace fixes and new line breaks;
- Add it to devicetree/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Rob Herring <robh@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab 2020-04-15 16:45:19 +02:00 • committed by Rob Herring
parent b91a770a69
commit afb6120519
2 changed files with 16 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
Documentation/devicetree/changesets.txt → Documentation/devicetree/changesets.rst
View file

@ -1,3 +1,9 @@
.. SPDX-License-Identifier: GPL-2.0
=============
DT Changesets
=============
A DT changeset is a method which allows one to apply changes A DT changeset is a method which allows one to apply changes
in the live tree in such a way that either the full set of changes in the live tree in such a way that either the full set of changes
will be applied, or none of them will be. If an error occurs partway will be applied, or none of them will be. If an error occurs partway
@ -15,17 +21,17 @@ The sequence of a changeset is as follows.
1. of_changeset_init() - initializes a changeset 1. of_changeset_init() - initializes a changeset
2. A number of DT tree change calls, of_changeset_attach_node(), 2. A number of DT tree change calls, of_changeset_attach_node(),
of_changeset_detach_node(), of_changeset_add_property(), of_changeset_detach_node(), of_changeset_add_property(),
of_changeset_remove_property, of_changeset_update_property() to prepare of_changeset_remove_property, of_changeset_update_property() to prepare
a set of changes. No changes to the active tree are made at this point. a set of changes. No changes to the active tree are made at this point.
All the change operations are recorded in the of_changeset 'entries' All the change operations are recorded in the of_changeset 'entries'
list. list.
3. of_changeset_apply() - Apply the changes to the tree. Either the 3. of_changeset_apply() - Apply the changes to the tree. Either the
entire changeset will get applied, or if there is an error the tree will entire changeset will get applied, or if there is an error the tree will
be restored to the previous state. The core ensures proper serialization be restored to the previous state. The core ensures proper serialization
through locking. An unlocked version __of_changeset_apply is available, through locking. An unlocked version __of_changeset_apply is available,
if needed. if needed.
If a successfully applied changeset needs to be removed, it can be done If a successfully applied changeset needs to be removed, it can be done
with of_changeset_revert(). with of_changeset_revert().

1
Documentation/devicetree/index.rst
View file

@ -9,3 +9,4 @@ Open Firmware and Device Tree
usage-model usage-model
writing-schema writing-schema
changesets