File: cmd.clock.markdown

package info (click to toggle)
watchman 4.9.0-9
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 9,992 kB
  • sloc: cpp: 27,459; python: 6,538; java: 3,404; php: 3,257; ansic: 2,803; javascript: 1,116; makefile: 671; ruby: 364; sh: 124; xml: 102; lisp: 4
file content (37 lines) | stat: -rw-r--r-- 1,027 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
---
pageid: cmd.clock
title: clock
layout: docs
section: Commands
permalink: docs/cmd/clock.html
---

Returns the current clock value for a watched root.

*Since 3.9.*

*The [capability](/watchman/docs/capabilities.html) name associated with this
enhanced functionality is `clock-sync-timeout`.*

`sync_timeout` specifies the number of milliseconds that you want to
wait to observe a synchronization cookie.  The synchronization cookie
is created at the start of your clock call and, once the cookie is
observed, means that the clock value returned by this command is at
least as current as the time of your clock call.

If no `sync_timeout` is specified, the returned clock value is the
instantaneous value of the clock associated with the watched root, and
may be almost immediately invalidated if there are any filesystem
notifications that are yet to be processed.

```bash
$ watchman clock /path/to/dir
```

JSON:

Note the third options argument is optional.

```json
["clock", "/path/to/dir", {"sync_timeout": 100}]
```