fileio: add brief explanations for flags

[thirdparty/systemd.git] / man / udev_device_has_tag.xml

diff --git a/man/udev_device_has_tag.xml b/man/udev_device_has_tag.xml
index 480257343caba605452f20abfeddda822ba9b872..9c64a4b45b9ba4f446ab8b0fa422d5bc04487cad 100644 (file)
--- a/man/udev_device_has_tag.xml
+++ b/man/udev_device_has_tag.xml
@@ -1,28 +1,10 @@
 <?xml version='1.0'?> <!--*-nxml-*-->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
 <!ENTITY % entities SYSTEM "custom-entities.ent" >
 %entities;
 ]>
-
-<!--
-  This file is part of systemd.
-
-  Copyright 2015 David Herrmann <dh.herrmann@gmail.com>
-
-  systemd is free software; you can redistribute it and/or modify it
-  under the terms of the GNU Lesser General Public License as published by
-  the Free Software Foundation; either version 2.1 of the License, or
-  (at your option) any later version.
-
-  systemd is distributed in the hope that it will be useful, but
-  WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-  Lesser General Public License for more details.
-
-  You should have received a copy of the GNU Lesser General Public License
-  along with systemd; If not, see <http://www.gnu.org/licenses/>.
--->
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
 
 <refentry id="udev_device_has_tag"
   xmlns:xi="http://www.w3.org/2001/XInclude">
@@ -30,15 +12,6 @@
   <refentryinfo>
     <title>udev_device_has_tag</title>
     <productname>systemd</productname>
-
-    <authorgroup>
-      <author>
-        <contrib>Developer</contrib>
-        <firstname>David</firstname>
-        <surname>Herrmann</surname>
-        <email>dh.herrmann@gmail.com</email>
-      </author>
-    </authorgroup>
   </refentryinfo>
 
   <refmeta>
@@ -133,12 +106,19 @@
     <function>udev_device_get_property_value()</function> and
     <function>udev_device_get_sysattr_value()</function> return a
     pointer to a constant string of the requested value. On error,
-    <constant>NULL</constant> is returned.</para>
+    <constant>NULL</constant> is returned. Attributes that may
+    contain <constant>NUL</constant> bytes should not be retrieved
+    with <function>udev_device_get_sysattr_value()</function>;
+    instead, read them directly from the files within the device's
+    <property>syspath</property>.</para>
 
     <para>On success,
     <function>udev_device_set_sysattr_value()</function> returns
     an integer greater than, or equal to, <constant>0</constant>.
-    On failure, a negative error code is returned.</para>
+    On failure, a negative error code is returned. Values that
+    contain <constant>NUL</constant> bytes should not be set with
+    this function; instead, write them directly to the files within
+    the device's <property>syspath</property>.</para>
 
     <para>On success, <function>udev_device_has_tag()</function>
     returns <constant>1</constant> or <constant>0</constant>,