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.

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

Add man pages for ice2slice and dsnode #3525

Merged
merged 2 commits into from
Feb 11, 2025
Merged

Conversation

pepone
Copy link
Member

@pepone pepone commented Feb 10, 2025

Fix #3499


.SH NAME

dsnode - The DataStorm Node server.
Copy link
Member Author

Choose a reason for hiding this comment

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

Should we update dsnode to use Ice::Service class?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, probably.

Comment on lines 13 to 14
The DataStorm node server allows discovering of registered nodes, and provides bridging of nodes with disabled server
endpoints. Full documentation for DataStorm Node server is available online at:
Copy link
Member

Choose a reason for hiding this comment

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

What does "provides bridging of nodes with disabled server endpoints" mean?

Copy link
Member Author

Choose a reason for hiding this comment

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

bridging: nodes with disabled server endpoints can connect to dsnode to receive data from other nodes. See Networking for additional information.

From https://doc.zeroc.com/datastorm/latest/features/node-server

Copy link
Member

Choose a reason for hiding this comment

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

I would write it as:
The DataStorm node server allows other DataStorm nodes to exchange topic discovery information without relying on UDP multicast. It also helps create deployments that span multiple IP networks.


.SH DESCRIPTION

ice2slice compiler transforms Slice definitions in (.ice) files used by Ice to Slice definitions in (.slice) files used
Copy link
Member

Choose a reason for hiding this comment

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

I'd write:
The ice2slice compiler transforms Slice definitions in .ice files into Slice definitions in .slice files.

.ice files are understood by the Slice compilers provided by Ice, while .slice files are understood by the new Slice compiler developed as part of IceRPC.


Full documentation for ice2slice is available online at:
.br
https://doc.zeroc.com/ice/3.7/language-mappings/javascript-mapping/client-side-slice-to-javascript-mapping/ice2slice-command-line-options
Copy link
Member

Choose a reason for hiding this comment

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

This URL is bogus?

.BR slice2cpp (1),
.BR slice2cs (1),
.BR slice2java (1),
.BR ice2slice (1),
Copy link
Member

Choose a reason for hiding this comment

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

No need to seealso itself

Comment on lines 13 to 14
The DataStorm node server allows discovering of registered nodes, and provides bridging of nodes with disabled server
endpoints. Full documentation for DataStorm Node server is available online at:
Copy link
Member

Choose a reason for hiding this comment

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

I would write it as:
The DataStorm node server allows other DataStorm nodes to exchange topic discovery information without relying on UDP multicast. It also helps create deployments that span multiple IP networks.

@pepone pepone merged commit 079552e into zeroc-ice:main Feb 11, 2025
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add man pages for new exe in Ice 3.8
3 participants