From 65c592111809f0132786036bc974f0b1f5529985 Mon Sep 17 00:00:00 2001
From: wuzhaomin <wuzhaomin@kylinos.cn>
Date: Fri, 10 May 2024 11:26:15 +0800
Subject: [PATCH] Update index.rst to improve the demo usage

---
 ...ex.rst-to-improve-the-demo-usage-314.patch | 61 +++++++++++++++++++
 python-filelock.spec                          |  6 +-
 2 files changed, 66 insertions(+), 1 deletion(-)
 create mode 100644 0002-Update-index.rst-to-improve-the-demo-usage-314.patch

diff --git a/0002-Update-index.rst-to-improve-the-demo-usage-314.patch b/0002-Update-index.rst-to-improve-the-demo-usage-314.patch
new file mode 100644
index 0000000..8b9d859
--- /dev/null
+++ b/0002-Update-index.rst-to-improve-the-demo-usage-314.patch
@@ -0,0 +1,61 @@
+From e2f121bf74eba9697698dc86696dd8a1ef21c03b Mon Sep 17 00:00:00 2001
+From: youkaichao <youkaichao@gmail.com>
+Date: Sat, 23 Mar 2024 18:22:11 -0700
+Subject: [PATCH] Update index.rst to improve the demo usage (#314)
+
+---
+ docs/index.rst | 19 ++++++++++++++-----
+ 1 file changed, 14 insertions(+), 5 deletions(-)
+
+diff --git a/docs/index.rst b/docs/index.rst
+index 5fb5fb6..1a7d72a 100644
+--- a/docs/index.rst
++++ b/docs/index.rst
+@@ -49,6 +49,7 @@ working directory is currently used. To do so, create a :class:`FileLock <filelo
+ 
+ .. code-block:: python
+ 
++    import os
+     from filelock import Timeout, FileLock
+ 
+     file_path = "high_ground.txt"
+@@ -62,16 +63,19 @@ locks:
+ .. code-block:: python
+ 
+     with lock:
+-        with open(file_path, "a") as f:
+-            f.write("Hello there!")
++        if not os.path.exists(file_path):
++            with open(file_path, "w") as f:
++                f.write("Hello there!")
++    # here, all processes can see consistent content in the file
+ 
+     lock.acquire()
+     try:
+-        with open(file_path, "a") as f:
+-            f.write("General Kenobi!")
++        if not os.path.exists(file_path):
++            with open(file_path, "w") as f:
++                f.write("General Kenobi!")
+     finally:
+         lock.release()
+-
++    # here, all processes can see consistent content in the file
+ 
+     @lock
+     def decorated():
+@@ -80,6 +84,11 @@ locks:
+ 
+     decorated()
+ 
++Note: When a process gets the lock (i.e. within the `with lock:` region), it is usually good to check what has
++already been done by other processes. For example, each process above first check the existence of the file. If
++it is already created, we should not destroy the work of other processes. This is typically the case when we want
++just one process to write content into a file, and let every process to read the content.
++
+ The :meth:`acquire <filelock.BaseFileLock.acquire>` method accepts also a ``timeout`` parameter. If the lock cannot be
+ acquired within ``timeout`` seconds, a :class:`Timeout <filelock.Timeout>` exception is raised:
+ 
+-- 
+2.9.3.windows.1
+
diff --git a/python-filelock.spec b/python-filelock.spec
index f392b6e..424dc6a 100644
--- a/python-filelock.spec
+++ b/python-filelock.spec
@@ -1,11 +1,12 @@
 Name:		python-filelock
 Version:	3.13.1
-Release:	2
+Release:	3
 Summary:	A platform independent file lock
 License:	Unlicense
 URL:		https://github.com/benediktschmitt/py-filelock
 Source0:    https://files.pythonhosted.org/packages/70/70/41905c80dcfe71b22fb06827b8eae65781783d4a14194bce79d16a013263/filelock-3.13.1.tar.gz
 Patch0:     0001-BugFix-fix-permission-denied-error-when-lock-file-is.patch
+Patch1:     0002-Update-index.rst-to-improve-the-demo-usage-314.patch
 
 BuildArch:      noarch
 
@@ -63,6 +64,9 @@ pytest
 %doc README.md
 
 %changelog
+* Fri May 10 2024 wuzhaomin <wuzhaomin@kylinos.cn> - 3.13.1-3
+- Update index.rst to improve the demo usage
+
 * Thu May 09 2024 wangxiaomeng <wangxiaomeng@kylinos.cn> - 3.13.1-2
 - Backport patch:fix permission denied error when lock file is placed in /tmp
 
-- 
Gitee