Bug 17927 - Требуется документация
Summary: Требуется документация
Status: CLOSED FIXED
Alias: None
Product: Sisyphus
Classification: Development
Component: libshell (show other bugs)
Version: unstable
Hardware: all Linux
: P2 enhancement
Assignee: Alexey Gladkov
QA Contact: qa-sisyphus
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-11-18 11:15 MSK by Vladimir V. Kamarzin
Modified: 2016-11-18 18:27 MSK (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Vladimir V. Kamarzin 2008-11-18 11:15:43 MSK
Самодокументированность исходного кода это конечно хорошо, но нужно хотя бы какое-то overview функций, краткий справочник.
Comment 1 Alexey Gladkov 2008-11-18 13:55:55 MSK
Какого рода документация нужна ? man-страницы (как для glibc) ?
Как я понимаю, будет не достаточно вынести описания функций.
Comment 2 Vladimir V. Kamarzin 2008-11-18 15:08:21 MSK
В долгосрочной перспективе - man-ы на английском. Дополнительно можно сделать статью на wiki на русском.
Comment 3 Mikhail Gusarov 2008-11-18 15:12:06 MSK
При наличии нормальных манов, на wiki нужны только проектные страницы на двух языках, с описанием, что такое libshell и где его репозиторий, для майнтайнеров других дистрибутивов - без этого те же sisyphus-mirror, mkimage или gear опакетить нормально нельзя.

Такое я сделать могу в любой момент.
Comment 4 Alexey Gladkov 2008-11-18 15:15:29 MSK
(In reply to comment #2)
> В долгосрочной перспективе - man-ы на английском.

Постараюсь сделать. Давно про это думал, но как-то из-за нескольких функций руки не доходили. Но раз вы просите, значит настал момент собраться и сделать.

> Дополнительно можно сделать статью на wiki на русском.

Увольте-с.
Comment 5 Mikhail Gusarov 2008-11-19 15:43:45 MSK
На вики:

http://www.altlinux.org/libshell
http://en.altlinux.org/libshell

Больше ничего особенно и не нужно.
Comment 6 Alexey Gladkov 2008-11-19 16:16:09 MSK
(In reply to comment #5)
> Больше ничего особенно и не нужно.
 
Говорите за себя.

Это не документация. Такую "документацию" я мог бы написать, чтобы ничего не делать.
Comment 7 Mikhail Gusarov 2008-11-19 16:19:25 MSK
> > Больше ничего особенно и не нужно.
> Говорите за себя.

На wiki больше ничего не нужно.
 
> Это не документация.

Это проектные страницы.
Comment 8 Repository Robot 2016-11-18 18:27:39 MSK
libshell-0.4.2-alt1 -> sisyphus:

* Fri Nov 18 2016 Alexey Gladkov <legion@altlinux> 0.4.2-alt1
- New version (0.4.2).
- Add more docs (ALT#17927).
- New utilities:
  + shell-terminfo to simplify work with terminfo.
  + cgrep utility.
- shell-getopt changes:
  + Fix encoding in comment.