jt2594838 commented on code in PR #441: URL: https://github.com/apache/tsfile/pull/441#discussion_r2004611334
########## src/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-C.md: ########## @@ -408,13 +377,14 @@ double tsfile_result_set_get_value_by_name_double(ResultSet result_set, const ch /** * @brief Gets string value from current row by column index. - * + * @param result_set [in] valid result set handle. + * @param column_index [in] the index of the column to be checked. Review Comment: (1 <= index <= result_column_count). ########## src/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-C.md: ########## @@ -122,16 +87,17 @@ void free_write_file(WriteFile* write_file); ### TsFile Writer Create/Close -When creating a TsFile Writer, you need to specify WriteFile and TableSchema. You can use the memory_threshold parameter to limit the memory usage of the Writer during data writing, but in the current version, this parameter does not take effect. +When creating a TsFile Writer, you need to specify WriteFile and TableSchema. You can use the memory_threshold parameter in +tsfile_writer_new_with_memory_threshold to limit the memory usage of the Writer during data writing, but in the current version, this parameter does not take effect. Review Comment: Why is this method not effective? ########## src/UserGuide/develop/QuickStart/QuickStart-C.md: ########## @@ -0,0 +1,238 @@ +<!-- + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +--> +# Quick Start + +## Dependencies + +- CMake >=3.11 +- Maven >=3.9.6 +- GCC >=4.8.5 +- Make >=4.3 + +## Installation Method + +Clone the source code from git: + +```shell +git clone https://github.com/apache/tsfile.git +``` +Run Maven to compile in the TsFile root directory: + +```shell +mvn clean install -P with-cpp -DskipTests +``` + +If Maven is not installed, you can compile tsfile using the following commands: + +```shell +mvnw clean install -P with-cpp -DskipTests Review Comment: mwnw.cmd for windows -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@tsfile.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
