[yast-commit] Request 243841 created by factory-maintainer (submit openSUSE:Factory/yast2-ftp-server)

Visit https://build.opensuse.org/request/show/243841 Description: Automatic submission by obs-autosubmit Actions: - submit YaST:Head/yast2-ftp-server => openSUSE:Factory/yast2-ftp-server changes files: -------------- --- yast2-ftp-server.changes +++ yast2-ftp-server.changes @@ -1,0 +2,5 @@ +Fri Aug 1 12:51:37 UTC 2014 - mvidner@suse.com + +- Enabled YARD docs, documented the basics of FtpServer. + +------------------------------------------------------------------- spec files: ----------- other changes: -------------- ++++++ yast2-ftp-server-3.1.2.tar.bz2 --- .yardopts +++ .yardopts @@ -0,0 +1,6 @@ +--no-private +--protected +--markup markdown +--output-dir doc/autodocs +--readme README.md +src/**/*.rb --- package/yast2-ftp-server.changes +++ package/yast2-ftp-server.changes @@ -1,4 +1,9 @@ ------------------------------------------------------------------- +Fri Aug 1 12:51:37 UTC 2014 - mvidner@suse.com + +- Enabled YARD docs, documented the basics of FtpServer. + +------------------------------------------------------------------- Wed Jul 30 09:35:28 CEST 2014 - schubi@suse.de - Taking vsftpd ftp-server default in autoyast configuration module --- src/include/ftp-server/complex.rb +++ src/include/ftp-server/complex.rb @@ -254,7 +254,6 @@ # @return `abort if aborted and `next otherwise def ReadDialog Wizard.RestoreHelp(Ops.get_string(@HELPS, "read", "")) - # FtpServer::AbortFunction = PollAbort; result = ReadFTPService() return :abort if !result return :abort if !Confirm.MustBeRoot @@ -272,7 +271,6 @@ # @return `abort if aborted and `next otherwise def WriteDialog Wizard.RestoreHelp(Ops.get_string(@HELPS, "write", "")) - # FtpServer::AbortFunction = PollAbort; ret = FtpServer.Write ret ? :next : :abort end --- src/include/ftp-server/write_load.rb +++ src/include/ftp-server/write_load.rb @@ -471,11 +471,20 @@ port_range != nil ? Builtins.splitstring(port_range, ":") : nil end - # Function return init value for UI widgets - # and prepare internal data structure for writing - # to config file - # Example: ValueUI("ChrootEnabled") => "yes"/"no" - + # Convert between the UI (yast), and system (vsftpd, pure_ftpd) settings. + # + # The system settings are multiplexed by + # {FtpServerClass#vsftpd_edit vsftpd_edit}: + # {FtpServerClass#VS_SETTINGS VS_SETTINGS} (for vsftpd_edit == true) or + # {FtpServerClass#PURE_SETTINGS PURE_SETTINGS} (for vsftpd_edit == false). + # + # @param [String] key + # in the {FtpServerClass#EDIT_SETTINGS EDIT_SETTINGS} vocabulary + # @param write + # - true: write to system settings from UI settings + # ({FtpServerClass#EDIT_SETTINGS EDIT_SETTINGS}) + # - false: read the UI settings from the system settings + # @return [String] the UI value (for read) or nil (for write) def ValueUI(key, write) ports = [] authentic = 0 --- src/modules/FtpServer.rb +++ src/modules/FtpServer.rb @@ -1,17 +1,20 @@ # encoding: utf-8 -# File: modules/FtpServer.ycp -# Package: Configuration of FtpServer -# Summary: FtpServer settings, input and output functions -# Authors: Jozef Uhliarik -# -# $Id: FtpServer.ycp 27914 2006-02-13 14:32:08Z juhliarik $ -# -# Representation of the configuration of FtpServer. -# Input and output routines. require "yast" module Yast + # Configure **both** [vsftpd][v] and [pure-ftpd][p] in a single class. + # + # [v]: https://security.appspot.com/vsftpd.html + # [p]: http://www.pureftpd.org/ + # + # For the configuration we have 3 vocabularies, + # mapped by {FtpServerWriteLoadInclude#ValueUI}. + # + # - pure-ftpd uses CamelCase keys + # - vsftpd uses snake_case keys + # - yast uses CamelCase keys which are almost(!!1!) + # the same as for pure-ftpd. class FtpServerClass < Module def main Yast.import "UI" @@ -155,11 +158,6 @@ @pure_ftpd_xinet_conf = [] [cut 432 lines to limit mail size] To REVIEW against the previous version: osc request show --diff 243841 To ACCEPT the request: osc request accept 243841 --message="reviewed ok." To DECLINE the request: osc request decline 243841 --message="declined for reason xyz (see ... for background / policy / ...)." To REVOKE the request: osc request revoke 243841 --message="retracted because ..., sorry / thx / see better version ..." -- Configure notifications at https://build.opensuse.org/user/notifications openSUSE Build Service (https://build.opensuse.org/) -- To unsubscribe, e-mail: yast-commit+unsubscribe@opensuse.org For additional commands, e-mail: yast-commit+help@opensuse.org