Conversation
jreidinger
reviewed
Oct 3, 2024
| let mut cmd = Cli::command(); | ||
| clap_complete::generate_to(aot::Bash, &mut cmd, "agama", &out_dir)?; | ||
| clap_complete::generate_to(aot::Fish, &mut cmd, "agama", &out_dir)?; | ||
| clap_complete::generate_to(aot::Zsh, &mut cmd, "agama", &out_dir)?; |
Contributor
There was a problem hiding this comment.
we should probably package each completion package separately with own supplements so on live cd it will install only shell ones.
57832db to
d883048
Compare
jreidinger
approved these changes
Oct 4, 2024
Merged
imobachgs
added a commit
that referenced
this pull request
Jan 13, 2025
Update to release version 11. * #1495 * #1564 * #1617 * #1618 * #1625 * #1626 * #1627 * #1628 * #1630 * #1631 * #1632 * #1633 * #1634 * #1635 * #1636 * #1639 * #1640 * #1641 * #1642 * #1643 * #1644 * #1645 * #1646 * #1647 * #1648 * #1649 * #1650 * #1651 * #1652 * #1654 * #1655 * #1656 * #1657 * #1660 * #1663 * #1666 * #1667 * #1668 * #1670 * #1671 * #1673 * #1674 * #1675 * #1676 * #1677 * #1681 * #1682 * #1683 * #1684 * #1687 * #1688 * #1689 * #1690 * #1691 * #1692 * #1693 * #1694 * #1695 * #1696 * #1698 * #1699 * #1702 * #1703 * #1704 * #1705 * #1707 * #1708 * #1709 * #1710 * #1711 * #1712 * #1713 * #1714 * #1715 * #1716 * #1717 * #1718 * #1720 * #1721 * #1722 * #1723 * #1727 * #1728 * #1729 * #1731 * #1732 * #1733 * #1734 * #1735 * #1736 * #1737 * #1740 * #1741 * #1743 * #1744 * #1745 * #1746 * #1751 * #1753 * #1754 * #1755 * #1757 * #1762 * #1763 * #1764 * #1765 * #1766 * #1767 * #1769 * #1771 * #1772 * #1773 * #1774 * #1777 * #1778 * #1785 * #1786 * #1787 * #1788 * #1789 * #1790 * #1791 * #1792 * #1793 * #1794 * #1795 * #1796 * #1797 * #1798 * #1799 * #1800 * #1802 * #1803 * #1804 * #1805 * #1807 * #1808 * #1809 * #1810 * #1811 * #1812 * #1814 * #1815 * #1821 * #1822 * #1823 * #1824 * #1825 * #1826 * #1827 * #1828 * #1830 * #1831 * #1832 * #1833 * #1834 * #1835 * #1836 * #1837 * #1838 * #1839 * #1840 * #1841 * #1842 * #1843 * #1844 * #1845 * #1847 * #1848 * #1849 * #1850 * #1851 * #1854 * #1855 * #1856 * #1857 * #1860 * #1861 * #1863 * #1864 * #1865 * #1866 * #1867 * #1871 * #1872 * #1873 * #1875 * #1876 * #1877 * #1878 * #1880 * #1881 * #1882 * #1883 * #1884 * #1885 * #1886 * #1888 * #1889 * #1890
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
While working on Agama's website we wanted to include some documentation about the CLI. Fortunately, clap includes support for generating markdown documentation, man pages, shell completions, etc.
After some research, we found out that the Rust community is adopting the xtask pattern, where you write those tasks using Rust code. And it plays really well with clap, as we can generate those artifcats from the sources.
However, we needed to do some refactoring to expose the CLI as a
libcrate so we can use it in our tasks.This pull request includes the following tasks:
manpages,completionsandmarkdown. The first step should be to take advantage of them and generate the artifacts at runtime. It is open for discussion whether we should do the same with the OpenAPI docs.Generating the man pages
$ cargo xtask manpages at 15:05:46 Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.27s Running `target/debug/xtask manpages` Generate manpages documentation at out/man $ ls out/man/ agama-auth-login.1 agama-auth-logout.1 agama-auth-show.1 agama-auth.1 agama-config-edit.1 agama-config-load.1 agama-config-show.1 agama-config.1 agama-download.1 agama-install.1 agama-logs-list.1 agama-logs-store.1 agama-logs.1 agama-probe.1 agama-profile-autoyast.1 agama-profile-evaluate.1 agama-profile-import.1 agama-profile-validate.1 agama-profile.1 agama-questions-answers.1 agama-questions-ask.1 agama-questions-list.1 agama-questions-mode.1 agama-questions.1 agama.1Todo