Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add sway-ipc.7.scd to document IPC protocol #3766

Merged
merged 1 commit into from
Feb 27, 2019
Merged

Add sway-ipc.7.scd to document IPC protocol #3766

merged 1 commit into from
Feb 27, 2019

Conversation

RedSoxFan
Copy link
Member

@RedSoxFan RedSoxFan commented Feb 24, 2019 •
edited by emersion

This is still a WIP and will ideally be completed before 1.0 is
released since it would be nice to have for release

Closes #707

This add sway-ipc.7.scd that documents the IPC protocol

Note: This increases the minimum scdoc version from 1.8.1 to 1.9.0 to
allow for table cells to be continued on the following line

@ddevault
Copy link
Contributor

Prefer to call this sway-ipc

@RedSoxFan RedSoxFan changed the title [WIP] Add swaysock.7.scd to document IPC protocol [WIP] Add sway-ipc.7.scd to document IPC protocol Feb 25, 2019
@RedSoxFan RedSoxFan force-pushed the sway-ipc-scdoc branch 3 times, most recently from 804b952 to cab8fc3 Compare February 25, 2019 08:26
@RedSoxFan
Copy link
Member Author

I have a few example replies/events to fill in (which I'll do in a few hours) so I'm going to leave the [WIP] for now. Everything else should be there so if anyone wants to review this and provide feedback, it is ready for that.

I documented every property that was documented for i3 and I think I got all the new additions for sway. Anything that is undocumented for i3 is also undocumented for sway.

@RedSoxFan RedSoxFan changed the title [WIP] Add sway-ipc.7.scd to document IPC protocol Add sway-ipc.7.scd to document IPC protocol Feb 25, 2019
@RedSoxFan
Copy link
Member Author

Ready for review

phue
phue reviewed Feb 26, 2019
View reviewed changes
swaymsg/swaymsg.1.scd Outdated Show resolved Hide resolved
ddevault
ddevault reviewed Feb 27, 2019
View reviewed changes
sway/sway-ipc.7.scd Outdated Show resolved Hide resolved
ddevault
ddevault reviewed Feb 27, 2019
View reviewed changes
sway/sway-ipc.7.scd Outdated Show resolved Hide resolved
ddevault
ddevault reviewed Feb 27, 2019
View reviewed changes
sway/sway-ipc.7.scd Outdated Show resolved Hide resolved
@ddevault
Copy link
Contributor

This looks great. Fix the FreeBSD build and a few minor issues and I'm +1 on merging.

@RedSoxFan
Copy link
Member Author

Fix the FreeBSD build

The FreeBSD build is failing because this requires scdoc 1.9.0 and it is using 1.8.1. I don't think that there is anything I can do about that

@ddevault
Copy link
Contributor

I'm guessing it involves syncing up with whoever maintains the scdoc port in FreeBSD.

@RedSoxFan
Copy link
Member Author

I'm guessing it involves syncing up with whoever maintains the scdoc port in FreeBSD.

Based on https://svnweb.freebsd.org/ports/head/textproc/scdoc/distinfo?revision=493833&view=markup, it looks like it was already updated ~48hrs ago

@RedSoxFan
Copy link
Member Author

@jbeich It looks like the scdoc port in FreeBSD was updated to 1.9.0 about 48 hours ago. Any idea why the CI is still pulling 1.8.1?

@jbeich
Copy link
Contributor

jbeich commented Feb 27, 2019

Packages on FreeBSD are always built using the whole tree on the package cluster. Building starts every Tuesday, Thursday, Saturday/Sunday at 01:00 UTC and roughly takes ~2 days to complete. The build in question simply hasn't finished yet. Once finished it may take a few hours to sync packages to the mirrors.

@RedSoxFan
Copy link
Member Author

@jbeich Thanks for the information! Sorry, never used any BSD before and from the web view it looked like it was updated. I didn't realize there was another process after since I'm used to Linux where it doesn't update the listing until it is available.

ianyfan
ianyfan previously requested changes Feb 27, 2019
View reviewed changes
Copy link
Contributor

@ianyfan ianyfan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One typo, others are more like stylistic choices

sway/sway-ipc.7.scd Outdated Show resolved Hide resolved
sway/sway-ipc.7.scd Outdated Show resolved Hide resolved
sway/sway-ipc.7.scd Outdated Show resolved Hide resolved
@RedSoxFan
Add sway-ipc.7.scd to document IPC protocol
f876009 
This add `sway-ipc.7.scd` that documents the IPC protocol.

This also increased the minimum scdoc version from 1.8.1 to 1.9.0 to
allow for table cells to be continued on the following line
@RedSoxFan
Copy link
Member Author

Update: FreeBSD build is passing now

@ddevault ddevault merged commit 9f58b27 into swaywm:master Feb 27, 2019
@ddevault
Copy link
Contributor

Thanks!

@RedSoxFan RedSoxFan deleted the sway-ipc-scdoc branch February 27, 2019 21:03
@jbeich jbeich mentioned this pull request Feb 28, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@phue phue phue left review comments

@ddevault ddevault ddevault approved these changes

@ianyfan ianyfan ianyfan left review comments

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@RedSoxFan @ddevault @jbeich @phue @ianyfan