Просмотр исходного кода

Merge pull request #35410 from soulshake/soulshake-precpu-to-percpu-api-docs

Replace 'precpu' with 'percpu' in API docs.
Sebastiaan van Stijn 7 лет назад
Родитель
Сommit
1ae8ca9e0c
7 измененных файлов с 9 добавлено и 9 удалено
  1. 3 3
      api/swagger.yaml
  2. 1 1
      docs/api/v1.19.md
  3. 1 1
      docs/api/v1.20.md
  4. 1 1
      docs/api/v1.21.md
  5. 1 1
      docs/api/v1.22.md
  6. 1 1
      docs/api/v1.23.md
  7. 1 1
      docs/api/v1.24.md

+ 3 - 3
api/swagger.yaml

@@ -5095,9 +5095,9 @@ paths:
         This endpoint returns a live stream of a container’s resource usage
         statistics.
 
-        The `precpu_stats` is the CPU statistic of last read, which is used
-        for calculating the CPU usage percentage. It is not the same as the
-        `cpu_stats` field.
+        The `precpu_stats` is the CPU statistic of the *previous* read, and is
+        used to calculate the CPU usage percentage. It is not an exact copy
+        of the `cpu_stats` field.
 
         If either `precpu_stats.online_cpus` or `cpu_stats.online_cpus` is
         nil then for compatibility with older daemons the length of the

+ 1 - 1
docs/api/v1.19.md

@@ -739,7 +739,7 @@ This endpoint returns a live stream of a container's resource usage statistics.
          }
       }
 
-The `precpu_stats` is the cpu statistic of last read, which is used for calculating the cpu usage percent. It is not the exact copy of the `cpu_stats` field.
+The `precpu_stats` is the cpu statistic of *previous* read, which is used for calculating the cpu usage percent. It is not the exact copy of the `cpu_stats` field.
 
 **Query parameters**:
 

+ 1 - 1
docs/api/v1.20.md

@@ -748,7 +748,7 @@ This endpoint returns a live stream of a container's resource usage statistics.
          }
       }
 
-The `precpu_stats` is the cpu statistic of last read, which is used for calculating the cpu usage percent. It is not the exact copy of the `cpu_stats` field.
+The `precpu_stats` is the cpu statistic of *previous* read, which is used for calculating the cpu usage percent. It is not the exact copy of the `cpu_stats` field.
 
 **Query parameters**:
 

+ 1 - 1
docs/api/v1.21.md

@@ -829,7 +829,7 @@ This endpoint returns a live stream of a container's resource usage statistics.
          }
       }
 
-The `precpu_stats` is the cpu statistic of last read, which is used for calculating the cpu usage percent. It is not the exact copy of the `cpu_stats` field.
+The `precpu_stats` is the cpu statistic of *previous* read, which is used for calculating the cpu usage percent. It is not the exact copy of the `cpu_stats` field.
 
 **Query parameters**:
 

+ 1 - 1
docs/api/v1.22.md

@@ -957,7 +957,7 @@ This endpoint returns a live stream of a container's resource usage statistics.
          }
       }
 
-The `precpu_stats` is the cpu statistic of last read, which is used for calculating the cpu usage percent. It is not the exact copy of the `cpu_stats` field.
+The `precpu_stats` is the cpu statistic of *previous* read, which is used for calculating the cpu usage percent. It is not the exact copy of the `cpu_stats` field.
 
 **Query parameters**:
 

+ 1 - 1
docs/api/v1.23.md

@@ -986,7 +986,7 @@ This endpoint returns a live stream of a container's resource usage statistics.
          }
       }
 
-The `precpu_stats` is the cpu statistic of last read, which is used for calculating the cpu usage percent. It is not the exact copy of the `cpu_stats` field.
+The `precpu_stats` is the cpu statistic of *previous* read, which is used for calculating the cpu usage percent. It is not the exact copy of the `cpu_stats` field.
 
 **Query parameters**:
 

+ 1 - 1
docs/api/v1.24.md

@@ -1036,7 +1036,7 @@ This endpoint returns a live stream of a container's resource usage statistics.
          }
       }
 
-The `precpu_stats` is the cpu statistic of last read, which is used for calculating the cpu usage percent. It is not the exact copy of the `cpu_stats` field.
+The `precpu_stats` is the cpu statistic of *previous* read, which is used for calculating the cpu usage percent. It is not the exact copy of the `cpu_stats` field.
 
 **Query parameters**: