1HWLOC-PATCH(1)                       hwloc                      HWLOC-PATCH(1)
2
3
4

NAME

6       hwloc-patch - Apply a topology difference to an existing XML topology
7

SYNOPSIS

9       hwloc-patch [options] [<topology.xml> | refname] [<diff.xml> | -] <out‐
10       put.xml>
11
12       hwloc-patch [options] [<topology.xml> | refname] [<diff.xml> | -]
13

OPTIONS

15       -R --reverse
16                 Reverse the sense the difference file.
17
18       --version Report version and exit.
19
20       -h --help Display help message and exit.
21

DESCRIPTION

23       hwloc-patch loads the difference between two topologies from a XML file
24       (or  from  the  standard input) and applies it to an existing topology,
25       generating a new, modified one.
26
27       The XML difference may have been computed earlier  with  hwloc-diff  or
28       hwloc-compress-dir.
29
30       If  <output.xml> is given, the new, modified topology is stored in that
31       new file. Otherwise, <topology.xml> is modified in place.
32
33       If refname is given instead of <topology.xml>, the input topology file‐
34       name  is  automatically guessed by reading the refname field of the XML
35       diff file.  By default hwloc-diff generates XML diffs  with  the  right
36       reference topology filename (without any path prefix).
37
38       If  -  is  given instead of <diff.xml>, the topology difference is read
39       from the standard input.
40
41       NOTE: If some application-specific userdata were been exported  to  the
42       input  XMLs, they will be ignored and discarded from the output because
43       hwloc has no way to understand and patch them.
44
45       NOTE: It is highly recommended that you read the hwloc(7) overview page
46       before  reading  this  man  page.   Most  of  the concepts described in
47       hwloc(7) directly apply to the hwloc-patch utility.
48

EXAMPLES

50       hwloc-patch's operation is best described through several examples.
51
52       Apply a XML topology difference file to an existing topology:
53
54           $ hwloc-patch fourmi023.xml diff.xml fourmi023-new.xml
55
56       Apply a XML topology difference file whole refname field  contains  the
57       right input topology:
58
59           $ hwloc-patch refname diff.xml fourmi023-new.xml
60
61       Apply a XML topology from the standard intput:
62
63           $ cat diff.xml | hwloc-patch fourmi023.xml - fourmi023-new.xml
64
65       Directly  compute the difference between two topologies and apply it to
66       another one, in place:
67
68           $   hwloc-diff   fourmi023.xml    fourmi024.xml    |    hwloc-patch
69       fourmi025.xml -
70
71

RETURN VALUE

73       Upon  successful  execution, hwloc-patch outputs the modified topology.
74       The return value is 0.
75
76       hwloc-patch also returns nonzero if any kind of error occurs,  such  as
77       (but not limited to) failure to parse the command line.
78

SEE ALSO

80       hwloc(7), lstopo(1), hwloc-diff(1), hwloc-compress-dir(1)
81
82
83
84
852.5.0                            Jun 14, 2021                   HWLOC-PATCH(1)
Impressum